Navigation Menu: Settings > Account Information
API Keys are enabled in the Account Information menu option under [Settings]
TIP: For best results, use Google Chrome when working on platform
Overview:
This article contains technical information on how to enable the platform APIs. There are several supported features for APIs.
To view current APIs and related documentation, please click the links below:
API Documentation: https://www.tdsynnex.com/ion/api/
API Endpoint: https://ion.tdsynnex.com/api/v1
To use the platform APIs, you must first enable the keys to your account. APIs support many of the features available through the platform's User Interface. API access is available to all partner-level accounts, and API access and secret keys are associated with platform admin user entities.
Look in the lower right-hand corner of the Account Information screen to enable the API keys.
Screen 1: This is the screen before any API keys are generated.
Screen 2: This is the screen after API keys are generated.
Once keys are created, you can [Show Key] or [Generate New API Keys]
Authentication
The platform API uses basic HTTP authentication. You will use the API Key as the username and API Secret as the password in your requests.
Response Format
The platform API offers two encoding formats for the response: JSON and XML. By default, the responses are encoded in JSON but you can change that using the Accept request header:
• Accept: text/xml
• Accept: application/json (default)
Filtering Results
By using the filter request parameter when requesting a list of entities, it is possible to filter the results according to the values of various fields of the requesting entity. The filter parameter will be specified in the following format:
• filter[FIELD_NAME:modifier]=FIELD_VALUE
The filter modifier is optional and, when present, changes the way the filter value is used to filter the entities. Possible values are:
Filter | Description |
exact | (default) The entity field value must be the same as the filter value |
partial | The entity field value may only partially match the filter value. Special characters may be used to control the matching process: · % - matches any string (including empty string) · _ - matches one single character Special characters can be escaped with a backslash to cancel their special function within a match. |
gt | Matches all values that are greater than the filter value |
lt | Matches all values that are lower than the filter value |
gte | Matches all values that are greater than or equal to the filter value |
lte | Matches all values that are lower than or equal to the filter value |
min | Matches all values that are greater than or equal to the filter value (same as gte) |
max | Matches all values that are lower than or equal to the filter value (same as lte) |
Example:
The following filters will find all the entities with name “John Doe” in the group with ID=23:
• ?filter[name]=John+Doe&filter[groupId]=23
The following filters will find all the entities that have the name starting with “Jo”:
• ?filter[name:partial]=Jo%
Sorting results
You can specify the sort fields using the sort parameter:
• sort[FIELD_NAME]=asc|desc
If multiple sort fields are specified, they will be applied in the order they appear in the query string.
Example: The following request will sort the results first by name ascending, then by company descending:
• ?sort[name]=asc&sort[company]=desc
Paging the results
The number of results per request can be limited using the limit parameter and the results offset within the entire results set can be specified using the offset parameter. Using these two parameters, you can paginate the results for a large list of entities. By default, the limit parameter is set to 100 and the offset parameter is set to 0 (zero).
Customizing the results
The platform's API offers the possibility of customizing the returned fields for the requested entities. Using the relations parameter, you can set the related entities that will be returned to the requested entity. Multiple related entities can be specified, separated by a comma. If the relations parameter is set to empty string, no related entity will be returned. By default, depending on the requested entity, some, all or none of the related objects may be returned.
Example:
• ?relations=invoices,group
If you do not see the above features, please open a support request ticket.
To submit a support request, in StreamOne Ion, click the "?" icon in the upper right menu bar or click the Support button in the menu. Alternatively, you can click Submit a ticket in the Knowledge Base. Fill out all mandatory fields, or read How to Use StreamOne Freshdesk to Submit and View Support Tickets for more information.