API Tokens
Last updated
Last updated
SoftwareOne is a trademark of SoftwareOne, Inc. "The Software Licensing Experts" is a service mark of SoftwareOne, Inc. VAR assist is a trademark of SoftwareOne, Inc. "It pays to partner" is a service mark of SoftwareOne, Incorporated.
The Marketplace Platform uses API tokens to authenticate requests to the REST API.
Your API token must be included in the Authorization HTTP header with the Bearer prefix for authentication. For example, the following request could be used to retrieve a list of buyers:
Your API keys have permissions assigned to them, so keep them secure. Do not share your secret API keys in public areas like GitHub or client-side code.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
Account administrators can access the API tokens page by selecting Settings > API tokens from the main menu.
The page displays all tokens that have been created in your account. For each token, you can view the following information:
API token - Displays the name of the token and its marketplace identifier.
Modules - Displays the total number of modules that the token has access to. In cases where only one module is within the scope, the module name is displayed.
Created by - Displays the name and marketplace ID of the person who created the token.
Date created - Displays the date and time when the token was created.
Last access - Displays the date and time when the token was last used.
Status - Displays the current status of the token. For more information on the status, see Token States.
Actions - Displays options that allow you to manage the API token. Depending on the status of the token, you can enable or disable a token, delete the token permanently, or edit token details.
The details page of a token displays additional information about the token. You can open the details page by clicking the token name on the API tokens page.
When you open the details page, it shows the token's name, marketplace ID, and status. The page also contains the following tabs that display corresponding information:
General - Displays the token's description and allows you to show, hide, and copy the values.
Modules - Displays the modules that the API token has been granted access to within the scope of an account.
Details - Displays the date and time information for your selected token, for example, the date and time when the token was created.
Audit trail - Displays an audit trail of all changes and events within the token account. For each audit record, you can view the log details and summary. To learn more, see Audit Trail.