Navigation Menu: Settings > Account Information

 

TIP: For best results, use Google Chrome when working in platform

 

Overview: 

This article provides technical details to enable the billing API for the platform. If your organization decides to leverage the platform billing API, it must be enabled on your account. Many functions available through the platform User Interface are also surfaced through APIs. Each partner-level account can have API access, and Access/Secret Keys for API access are associated with platform admin user entities.

All API documentation can be found on:  


API Documentation:  http://api-ses.techdata.com

API Endpoint :  https://ses.techdata.com/api/v1



The API function should already be active in your platform management console.  The API function is located in the Settings module, on the Account Data screen.


Screen 1: Before any API keys are generated



Screen 2: After API Keys are generated


If you do not see the above features, please open a support request ticket.  


To open a support request, click on the "?" icon in the top right menu bar, or from the home page, click on the [Support] Module.  Complete all the required fields.  The SES Operations team will enable the API feature and update you via your ticket when your request is complete.


Once notified that the API has been enabled, from the Account Information screen click the “Generate new API keys” link



1.  Click [Generate] on the popup

 

 

2. You will now see the “Show access keys” link, which will have the API Key and API Secret codes (See Screen 2 above)

 

3. Open a new browser window and go to http://api-ses.techdata.com/ to access the platform API

   

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

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 

When requesting a list of entities, the results can be filtered by the values of different fields of the requesting entity using the filter request parameter. 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 API offers the possibility to customize 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