QuickStart

All our APIs can be explored without needing to authenticate, but in order to actually test an API a valid Access Identity account, that has access to the corresponding product, is required.

There are both RESTful APIs and GraphQL APIs. Usually the GraphQL APIs are more feature rich, while RESTful APIs expose simpler operations.

Calling the APIs require both a valid subscription and a valid security token.

Subscriptions

Subscriptions can be created from the Developer Portal.

To create a new subscription follow the steps:

  1. Sign in with you preprod Access Identity account that has access to the product for which you want to test an API.

  2. Once signed in you will get in the top right menu the Products option, click on it, in there you should see the list of products that have an ERP API and to which you have access in Workspace.

  3. In the product list click on the product for which you want to test the APIs and then click on Subscribe button to create a new subscription

  4. In order to see the subscription keys please navigate to Profile page, there you can see all subscriptions and you have the option to copy the subscription key

Security Token

Can be generated from within Workspace using the ERP Token Generator widget. Token can only be obtained by the organization administrator.

Make a Call

APIs can be tested directly from Developer Portal following the steps:

  • Click on the APIs menu options and find the API endpoint you what to call

  • In the right side you should have the Try It button, click on it and you will access the UI that allows you to make the call

  • Before you send the call make sure you have populated Subscription Key. If you are connected with an Access account and you have already subscribed for the product the subscription will be automatically populated. In addition you also have to populate Authorization header with a valid security token in the format: Bearer [security-token]

  • Click Send button and see the result.