Participation in Shop and Share model with apidd.com

Welcome to apidd.com
Participation in Shop
and Share model
presented by Elixir Software Co., Ltd.

Search API
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

Explore
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
Display API
overview

API Overview - Documentation
API 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

API Overview – Getting Start
Follow API to
receive update
information
Getting start
information
Link to more
information on
provider website

API Overview – Getting Terms&Conditions
Follow API to
receive update
information
Terms and
Conditions
for API use
Link to more
information on
provider website

API Overview – Issue
Add new issue
Open Issues:
Issue that
approved but still
not have answer
from provider
Close Issues:
Issue that already
answered from
provider

API Overview - Status
Current status
of API service
health
Current
Uptime and
Latency
API service health
graph report of
latency rate
Weekly
report of
API service
health

User Profile
API list partition by published,
consumed and follow
Current user
activities
Show user profile
and the gallery of
showcase on the
right

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/Optional)

API Overview – Test Endpoint
Endpoint
Description
Endpoint
Name
3. response from
API call will display
in first tab

Digitized Thailand Digital Platform software service Thailand One Click (T1C)

APIDD Website Login /
Register
Search API
API Display
Shortcut
to Menu

+Join Us(1)
1. Click “Join Us”
to register
2. Fill in all required
information. * is required
Hint /
Information
3. Check
availability
display name.
4. Click “Register”
button to register
account

+Join Us(2)
5. System will send
email to activate the
account. Click
activate link inside
email to confirm
email and activate
account.
6. When account is
activated, system will
rlogin and redirect to user
dashboard.

Login 1. Login to
ApiDD website
2. Fill in email that
you registered to
Username
3. Fill in your
password
4 Click “Login” to
login ApiDD
Website

Main Menu
Show
overview
data
Manage the
production
key
Manage
your APIs
Manage
showcase of the
website/system
that using our
API
Setup
your
profile
data
After login, move a mouse under the header.
The main menu will appear as image below.

Dashboard
Key for testing
API
List of your
APIs
List of your
showcases
Recent
activities
Click “Setting” button to edit
showcase’s detail.
Click “API Console” button to
view showcase page.
Click “Edit Document” button to
edit API’s detail.
Click “API Console” button to
view API page.
Click “View
More Activity”
to view more
recent activity

Key-Store – Create Production Key
Key for test API
List of production key
1. Input URL or
Application name
that will using API
2. Click “Create Key”
to create production
key

API Management
API Information
Display View, Test, Download,
Consume, and Follow Statistic
Click “Usage” button
to view the usage of
API
Click “Edit
Document” button to
edit API’s detail

API Management - Usage
Sub menu of
the usage
Hover on the graph to view the detail.
to view usage of API

Showcase Management
The showcase will appear after create
production key already Click “Edit Document”
button to edit showcase
to view the usage of
API
Display View, Test, Download, Consume, and
Follow Statistic

Showcase Management - View
Showcase’s detail
Showcase’s image
Display View,
Test,
Download,
Consume, and
Follow
Statistic
1. Click on the
showcase’s name

Account Setting - Profile Setting
1. Complete the
form
2. Click
“Upload
Image” button
to upload
image
Click “View Profile Page” button to view
User’s profile that public to everyone
3. Click “Save Setting” button
to save

Account Setting - Account Setting
1. Complete
the form
Change
Email
Change
Password
2. Click “Save Setting”
button to save

Account Setting - Notification
1. Select
Off/On of
each
notification
2. Click “Save Setting”
button to save

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 Data Choose service protocol:
REST or SOAP
Set email notification and
API publication
4 click “Add API”
to save data

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

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

Add API – 4. Base URL
Base 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”

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

2 Setup successful
Response
3 Setup error
Response

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

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”

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

API Overview - Documentation
API 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

Dashboard – Create Key-Store
1 Click “Key-Store”
to generate key
for application

2 Fill in website or
application name
and description that
will use API
“Key-Store” use for authorizing between your
application and called API
3 Click “Create Key” to
generate Key-Store

4 system will generate key for
your website/application

API Overview – Download Library Code
5 Click “Explore” to
view API
6 Choose API that you
want to use

API Overview – Download Library Code
8 Click “PHP” to
download client library
7 Choose your registered
website/ application

API Overview – Apply Code to Your Web
9. Extract download file, you will get
lib folder and service in PHP code
Inside Thai_SoundexService.php

input parameters of API function

Thai_SoundexService.php
(download file)
process.php
(your website/application)
include download file
input parameter value
new class
call function
display output result
from API

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

Showcase – Display your website
You can post your website
information on ApiDD to
publish your web

Showcase – Display your website
Your website will display as
showcase in ApiDD
Viewer can link to
your website
Show No. of Viewer

1 Click “Key-Store” to
setup your website
information

Key-Store
2 Click “Edit Document”
on website

Showcase Management – Edit Document
3 Fill in all information
4 Upload website
Interface
6 Click “save” to record data
5 Set “public” to show in
ApiDD showcase

Participation in Shop and Share model with apidd.com

Recommended

Recommended

More Related Content

Viewers also liked

Viewers also liked (6)

Similar to Participation in Shop and Share model with apidd.com

Similar to Participation in Shop and Share model with apidd.com (20)

Recently uploaded

Recently uploaded (20)

Participation in Shop and Share model with apidd.com