HOW TO TEST AN API  ?

Prequisites

Have an account.

Step 1:  Devportal Connection

• Click on the « Log in” button in the header

• Complete the fields: Username and password

• Click on the "Connection” button
• Complete the unique use code generated on your mobile
• Click on the "Connection” button

Step 2: Create an app 

• Create an app to get an API Key and Secret (or copy your credentials if you already have an app) on the “profile” button then on the “My application” page

• Click on “Add app”

• Complete the fields: App Name, Callback URL, Description

The “Callback URL” field must be filled with the Callback URLs list (separated by) in the case the API is secured in authorization code flow and for the SSO

• Select the APIs product you want to subscribe

(Optional) In the case the app you want to subscribe requires a certificate:

• Select your certificate to join to “App”

• Click on « Save » to save the changes

The following screen shows you the list of your app.

Step 3: Browse the API catalog

• Browse the API catalog to identify the API that fits your needs

• Go to the API Card by clicking on it
• On the "Doc" tab, you can find the swagger

Step 4: Click on the authorize button

• Click on Authorize (this will hit the sandbox token endpoint with your App Client ID/Secret for you)
• When the OAuth 2 token was successfully generated, the button change to "Logout" and "Close", click on "Close"
• From that point, the UI will send automatically add the bearer token to the Authorization header

• Select the endpoint you want to test
• Click on the "Try It Out" button to test it
• Enter values in the headers, in particular the mandatory ones with a "* required"
• Click on the "Execute" Button
• Check the results of your API calls