Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
A token can have multiple states during its lifecycle in the Marketplace Platform.
The following diagram shows the possible states and the transition between these states:
These states are displayed as Status within the platform. They are also displayed as an icon beside the token name and ID on the details page.
Copy an API token.
Follow these steps to copy your token values:
Navigate to the API token page (Settings > API tokens).
Find the token to copy and click the token name. The details page of your selected token opens.
From the General tab, copy the values as needed.
To copy the endpoint, click the copy icon for the API endpoint.
To show the token value, click the eye icon. To hide the value, click the icon again.
To copy the token value, click the copy icon for the API token.
Create an API token to access Marketplace Platform using APIs
Follow these steps to create a new API token:
On the API token page (Settings > API tokens), click Add. The Add API token page opens.
In the General section, provide the following details and then click Next.
Logo - (Optional) Add an image for your token. You can select a file to upload or drop your file to the selection area. By uploading an image, you can easily identify your token from the list of tokens.
API token name - (Required) Enter a name for your token.
Description - (Optional) Describe your token.
In the Modules section, select the modules to which the token will allow access and click Next. Note that only the modules that SoftwareOne has enabled for your account are displayed in this section.
In the Overview section, review the details and click Add. Your token is created and a summary is displayed.
Click View details to open the details page of the token. Otherwise, click Close to close the page.
Disable an API token temporarily and enable it again when required.
Before disabling a token, note the following points:
The Enable option is shown only if you've disabled the token previously.
Follow these steps to enable or disable a token:
Navigate to the API token page (Settings > API tokens).
Find the token you want to enable or disable.
Click the actions icon (•••) for the token and select Enable or Disable. The following image shows the Disable option:
Alternatively, click the token name. When the details page of your selected token opens, click the down arrow and select Enable or Disable.
Confirm that you want to change the status of your token.
A message is displayed stating that the operation is successful. You can view the updated status of your token in the Status column on the API token page.
Delete an API token.
Before deleting a token, note the following points:
A deleted token cannot be reinstated or reused.
Deleting a token removes it from the account, which means that the token is no longer displayed on the API Tokens page.
Follow these steps to delete a token:
Navigate to the API token page (Settings > API tokens).
Find the token you want to delete.
Click the actions icon (•••) for the token and select Delete.
Alternatively, click the token name. When the details page of your selected token opens, click the down arrow next to Edit and select Delete.
In Delete API token, confirm that you want to delete the token.
A message is displayed stating that the API token has been deleted successfully.
Edit an API token.
Follow these steps to edit an API token:
Navigate to the API token page (Settings > API tokens).
Click the actions icon (•••) for the token to modify and select Edit. The Edit API token page opens.
Edit the General and Modules sections as necessary.
Click Save. Your changes are saved and reflected immediately on the API tokens page.
State | Definition |
---|---|
Disabling does not but makes it inactive until it is enabled again. When a token is disabled, any attempts to access the endpoint return an error.
Active
The token has been authenticated in the account.
It will allow access to the endpoint.
Disabled
The token has been temporarily deactivated.
Any attempts to access the endpoint will return an error.
Deleted
The token has been permanently removed from the system.
This state is not visible to the client or vendor account users.
Learn about API tokens and how to access the API tokens page.
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 navigating to the main menu of the platform and selecting Settings > API tokens.
From the API tokens page, administrators can:
Create new tokens to access different workflows and modules within the Marketplace platform.
Edit a token to update its name, description, and list of modules.
View a list of tokens.
Copy the token values for use in your application.
Delete a token if it's no longer needed.
Disable a token temporarily and then re-enable it as needed.
Learn about the fields and actions available on the API tokens page.
The API tokens page, located under Settings > API tokens, displays all tokens 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 API token has access to. If there is only one module, 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.