Authorization to use the APIs

Only authorized users with a registered IBMid can make API calls. If necessary, contact your Solution manager for authorization to use this API. Authenticate to use the Trace APIs with your registered IBMid, as follows: Only authorized users with a registered IBMid can make API calls. If necessary, contact your Organization administrator for authorization to use the APIs. Authenticate to use the APIs as follows:

1. Open the IBM Blockchain Solution Manager page in a new tab or window.
2. Log in with your IBMid, and if necessary, select your organization
3. Copy your user token
4. In the Authorization Header of your API call, paste your token in the format Bearer <token> A 200 success message indicates you are authorized to use the Transparent Supply APIs. User tokens expire after two hours. For subsequent sessions, repeat the steps above to obtain and use a new user token. (Cloud IAM service ID tokens expire after one hour.)

You are now authorized to use the API. For subsequent sessions, repeat the steps above to obtain and use a new user token.

Usage notes

Review the following usage details before calling any Trace API:

• Ensure that you authenticate using the previous steps. For any issues authenticating a user ID or a system ID, contact your Organization administrator.
• To trace a product, use the EPCs APIs. All other Trace APIs retrieve product, location, event, or related information.
• Use the POST version of each GET API to increase the limit of values per parameter from 30 to 200.
• No data is uploaded by any Trace API call. Use the Connector APIs to upload data.

Common parameters and responses

• GET APIs have a limit of 30 elements per parameter
• POST APIs have a limit of 200 elements per parameter
• next contains a url that points to the next page in the response. If a `limit`` was passed or the response exceeds the default limit, this URL will direct to the next page.
• If total_count is part of the response, it is a total count of the elements that will be returned over the set of pages. Note that if data is ingested to the system while paging, then the total count after paging might be more than the initial count.