Developer's Portal - API Subscribe

API Subscriptions (Sandbox/Test)

Once you create an account, you can log in to access the 300+ data source APIs for your needs. To start with an API there are two main requirements to be fulfilled

(1) Subscribe to an API

• Click on the API, you want to subscribe, to open the API page.
• In the overview tab, there is a subscriptions section with subscribe button with text saying "No Application subscriptions". 

If not then you have already subscribed to the API

• On clicking the subscribe page, it will take you to the subscriptions. The application name "IDMverify" is a constant, however, the throttling policy is to be selected according to your needs. The default is set to Sandbox which is Free for testing and integration.
• Click on Subscribe. This will show the subscription page and the application status.

(2) Generate access to an API

The API once subscribed can only be accessed with an access token. This can be generated from the Portal or by an API call using programming or tools like Postman. 

• From the subscription page, click on Sandbox Keys
• This opens a form with a "Consumer key" (username) and "Consumer Secret" (password), which will be used as username and password to generate an access token.
• Click on Generate Access Token button, which will open another form with Access token validity. The default validity is set to 3600 seconds (1 hour). 
• Once the validity is adjusted click on the "Generate" button
• This will provide a token with the validity of the time you mentioned in the scope.

(3) Testing the API

• Once the token is generated, copy the token and close the token window.
• Navigate to the Try Out tab.

• Paste the Copied token to the "Access Token" text box. Make sure to keep the "Key Type" with respect to the generated token.

• Scroll down to see the default API and click on "Post". You'll see form fields with sample data pre-filled for testing. 

• Click on "Try it out" to enable the Test parameters. Once enabled, click on Execute button to execute a test

• The response will be displayed below

Possible Errors

<ams:fault xmlns:ams="http://wso2.org/apimanager/security">
  <ams:code>900901</ams:code>
  <ams:message>Invalid Credentials</ams:message>
  <ams:description>Access failure for API: /us-1/2.1, version: 2.1 status: (900901) - Invalid Credentials. Make sure you have provided the correct security credentials</ams:description>
</ams:fault>

Solution

Error Code: 401. Your credentials/token is invalid. Please check and try again.

(4) Subscribing to Production

Please note the production subscription requires a service agreement to be signed by you and approved by IDMERIT. Once signed you can follow the below steps to subscribe to the production environment

• Log in with your production account
• Click on your subscribed API
• Click on Subscriptions
• Select "Production" as the throttling policy and click Subscribe

First-time production users have to get two approval 

(1) API Approval for Production

On clicking Subscribe, your application status will show "On_hold". Please note, a request is sent to the IDMERIT administration team to verify the agreement and scope of API. If the scope matches, the request is accepted and the API status changes to "Unblocked"

(2) API Key Approval for Production

On trying to generate the API production key, you may see this message "A request to register this application has been sent and is pending approval". This sends a request to IDMERIT administrators for first-time production key approval. Please note this is only a one-time process.