1

Welcome toWeb Service Platform

Repository

2

Concept

Consumer

of API

Providerof API

Repository

(virtual mall for APIs )

3

Everything in one Place

Click at API name to

explore API information

Click “go” to search API with specify keyword

Click to show APIs

in the specify

category

Filter API results by

specify features

Collecting every web services of your company in one place to make it easy to search, view, and compare results.

4

Instant Distribution

Click here to publish your API

Provider can setup web service in private mode for testing and distribute API in public mode in one click.

Multiple Client Libraries

5

PHP Client Library for calling API

Provide many client library for calling API that make your company easy to use

1 Fill in terms and conditions of using API

2 Fill in URL or website for more information.

3 Click “Save” to save data

You can choose template from example

Fast API Doc Editor

6

Provider can fill in document and write instructions of how to use within system.

Sub menu of the usage

Hover on the graph to view the detail.

1. Click “Usage” button to view usage

of API

Track APIs Usage

7

Company can track API usage in graphical view.

Current status of API

service health

Current Uptime

and Latency

API service health graph

report of latency rate

Weekly report of

API service health

8

API Status and Notification

Company can track service health of API in the graphical view.

9

Provider of API FlowProvider

of API

10

Add API – 1. Register

Show all steps of API registration

1 Click “Add an API”

2 Click “Upload image”

to upload API icon (recommend 150x80 px)

3. Fill in API Information

Choose category: Tools

or DataChoose service

protocol: REST or SOAP

Set email notification and API publication

4 click “Add API”

to save data

11

Add API – 2. Getting Start

1 Fill in the definition, usage, and instruction of API

2 Fill in URL or website for more information.

3 Choose to show/hide this information to consumer

4 Click “Save” to save data

12

Add API – 3. Term & Condition

1 Fill in terms and conditions of using API

2 Fill in URL or website for more information.

3 Choose to show/hide this information to consumer

4 Click “Save” to save data

You can choose template from example

13

Add API – 4. Base URLBase URL is the located URL of service

1 Fill in base name 2 Fill in base URL

You can add multiple URL for your service

3 Click “Save” to save data

You can add multiple base by click “Add Base URL”

You can add multiple URL by click “Add URL”

14

Add API – 7. Endpoints (1)Endpoint is service of API including protocol, route, response, error, and parameters

All endpoints show here

Add new endpoint, click “Add”

Base URL (from created list of Base URL)

Protocol (POST/GET)

1 Fill in Endpoint information

Route/Path to call API

15

Add API – 7. Endpoints (2)

2 Setup successful Response

3 Setup error Response

16

Add API – 7. Endpoints (3)4 Setup input parameters

Check optional if allow no input to parameter

Check hidden if do not allow user to see parameter

Show full HTTP route

Show ApiDD key of this API

3 Click “Save” or “Finish” to save data

17

Add API – 5. Namespace (for SOAP)Namespace use in defined new model for SOAP

method

1 Fill in Namespace URL and description

2 Click “Save” to save data

You can add multiple namespace by click “Add Namespace”

18

Add API – 6. Models (Optional)Model is customize type of parameter that you defined for using in endpoint.

All models show here

Add new model, click “Add”

1 Fill in model information

2 Choose parameter type. If you have multiple type, choose “Model”

You can add multiple parameter type in one model

3 Click “Save” to save data

19

API Overview - DocumentationAPI

Information

Display View, Test,

Download, Consume, and

Follow Statistic

API Status

API Endpoint Information

PHP Client Library for calling API

Endpoint Parameters

Test API call

After finish, you will lead to Test Console

20

Consumer of API FlowConsume

rof API

21

How to use

1. Type keyword in to search box

to search API

2. Click “Search” to

search API with specify keyword

Click “Explore” to view all API

22

API Overview – Test Endpoint

Endpoint Description

Endpoint Name

1. Input testing data to the

input parameters

2. Click “Test” button to test

API call

Input parameters (Required/Optiona

l)

23

API Overview – Test Endpoint

Endpoint Description

Endpoint Name

3. response from API call will

display in first tab

24

API Overview – Download Library Code

8 Click “PHP” to download client

library

7 Choose your registered website/

application

25

API Overview – Apply Code to Your Web

input parameters of API function

26

API Overview – Apply Code to Your WebThai_SoundexService.p

hp(download file)

process.php (your

website/application)

call function

27

API Overview – Output from APIprocess.php output from API (JSON format)