UAE API MARKETPLACE
USER GUIDE
PRE-REQUISITES / TERMS & CONDITIONS
Pre-Requisites
• Access is available only to Private sector entities holding a valid UAE trade license.
• Private entity user should have a valid UAE PASS account.
Terms & Conditions
• Private entity will be responsible for maintaining the confidentiality of the data consumed from the services exposed by
UAE API Marketplace.
• Private entities should use this data only for the intended purpose approved by the API provider Government entity and
must be compliant to any applicable laws and regulations set by the government of UAE.
• UAE API Marketplace will not be responsible for any non-compliance from Private entity on data confidentiality.
• As part of the onboarding process to consume a service exposed in UAE API Marketplace, the API provider and private
entities are expected to have a Memorandum of Understanding (MoU) signed between themselves or follow the protocol
or process specific to entities on the quality of data and the confidentiality of the data.
The information passing through UAE API Marketplace will be maintained by the following mechanisms:
• APIs can be consumed only after approvals from UAE API Marketplace team and API provider Government entity.
• UAE API Marketplace will not store any business information being exchanged between API provider and private
entities, unless otherwise specified by the API provider Government entity.
02 UAE API Market Place User Guide
EXPLORE
UAE API MARKETPLACE
HOME PAGE
Contact Support for
assistance
Click on the ‘API Catalog’ Language selection Search APIs using
to explore the APIs (Arabic /English) keywords
Scroll down to view more
04 UAE API Market Place User Guide
API CATEGORIES
View the various API
Categories available Explore Our API Catalog Click here to explore all the APIs
05 UAE API Market Place User Guide
API CATALOG
Click here to view the APIs
This section displays the API listed based on ‘API group’ or
name, description and API type ‘Communities’
Click to view the API
Specification
06 UAE API Market Place User Guide
TRY API
UAE API MARKETPLACE
API SPECIFICATION
A short description about the API
Click on API resources section to view the Resources/ Operation details of an API
Click on
“Try API” to Click on API documents section to view the API Specification documents like YAML,
test the WSDL and Sample request & response documents
APIs
Details of the Policies enforced on an API are listed in API policies section. E.g.,
Authentication /Authorization policy (Oauth, APIKey)
API Endpoint is available in the Access API section
08 UAE API Market Place User Guide
TRY API – REQUEST
4 Click on the Parameters section and API Endpoint 5 Click on ‘Send’ button to
enter the API parameters if applicable retrieve the response
2 Click on the Body section. A sample
request is loaded in the Request
window.
The attached samples in the API
Specification – API Documents section
can be tested from here
1
3 Enter the transport level header Click to clear
Click on the Resource to the request
parameters in “Headers” section
select the resource to ‘Try details
API’
Click to upload a Sample Request File
09 UAE API Market Place User Guide
TRY API – REQUEST
HTTP Status Code Transport header details
Sample response is displayed
in the “Body” section
10 UAE API Market Place User Guide
USER REGISTRATION
HOME PAGE – UAE PASS
Click on “Login”
Click on “Sign in with
UAE PASS”
12 UAE API Market Place User Guide
USER REGISTRATION USING UAE PASS
1 3
Enter the UAE PASS email Id/ Notification screen appears
Mobile Number/ Emirates ID indicating to authenticate from
mobile app
2
Click on Login
4
Pop up window appears on
successful registration
5
6
User receives a notification in the UAE
User receives a notification in the work email ID and should respond with Pass registered email Id to share the work
the text ‘Confirmed’ for processing the registration request email ID , trade license number and copy
13 UAE API Market Place User Guide
INTEGRATE
UAE API MARKETPLACE
LOGIN
1
Login using UAE PASS
Click on ‘Get access token’ link
from the ‘What’s next?’ section
2
Browse through API Catalog and select the API of
interest by clicking on ‘View details
15 UAE API Market Place User Guide
ACCESS TOKEN DETAILS
1
Enter the Application Name in the
following format
APIKey_<<BusinessApppName_APINam
e>>
2
Enter the consuming application description
3
Click on ‘Request Token’ button
16 UAE API Market Place User Guide
ACCESS TOKEN REQUEST CONFIRMATION
A popup message appears to
confirm on the successful
generation of request for access
token
17 UAE API Market Place User Guide
HOME PAGE
Click on ”Applications” to view the
Access Token Details
18 UAE API Market Place User Guide
ACCESS TOKEN
• The approved access tokens for Stage
environment is listed in the page. Click on
the name to view the access token details &
integrate your application in Stage
environment.
• Once development and testing is completed
in Stage, drop an email to
gsb.support@fednet.gov.ae
• Post validation, Production environment
access will be provided.
19 UAE API Market Place User Guide
ENTITY ROLES
UAE API MARKETPLACE
ENTITY ROLES
Private entities consuming the APIs from UAE API Marketplace and the API provider entities are expected to adhere to API Usage guidelines
covering the following areas.
Area Description Responsible Entity
Data Confidentiality Maintain the confidentiality of data received from the API Private Entity
Data Usage Use data for the intended purpose approved by API provider and should not Private Entity
misuse data. API call rate should be within agreed limits.
Data Compliance Comply to any applicable laws and regulations set by the Government of Private Entity
UAE.
API Authorization Security credentials should be used only for the approved consuming Private Entity
application.
Approvals API consumption request should be approved within SLA. API Provider Entity
API Availability API should be available most of the time. API Provider Entity
API Performance API response time should be within the agreed limits. API Provider Entity
Data Quality Maintain data correctness and coverage. API Provider Entity
Change & Incident Any changes or incidents causing impact should be communicated to API Provider Entity
Management consuming entity in advance.
21 UAE API Market Place User Guide
THANK YOU
