Api tracking code

Get Started

Format

Soget API platform exposes RESTful APIs.

Our API uses the HTTP methods to connect to our data sources. It returns responses in JSON format in UTF-8 encoding. It uses:

  • ISO-8601 format for date and time,
  • JSON object or JSON array in the body of POST and PUT methods,
  • Application/json; charset=UTF-8 in the parameter Content-Type of the header

Parameters

Parameters must be passed:

  • in the URL’s query string for GET and DELETE requests;
  • in the request’s body for PUT and POST requests.

If the call requires other parameters, add them as well with the appropriate values.

Parameters passed in the URL must be properly URL-encoded, using UTF-8 encoding for non-ASCII characters. Also, the plus character (+) is interpreted as a space (so it’s an alternative to %20). Unless otherwise stated, arrays passed in the URL can be specified either:

  • as a comma-separated string; example: attributesToRetrieve=title,description; or
  • as a JSON array (which must be properly URL-encoded, of course);

example: attributesToRetrieve=%5B%22title%22,%22description%22%5D.

Arrays passed in the body should always be regular JSON arrays.

What You Need

In order to make requests, you must have an account and update your password. THEN,

  1. Create an organization
  2. Create a client application
  3. Retrieve your authentication tokens : Authentication
  4. Subscribe to an offer
  5. Retrieve your API Key : Authentication

Make your first request

For the first examples, you can use your terminal, with curl, sending the request.

It returns a JSON response like this:

{
    "code": "CCGM",
    "name": "CMA CGM",
    "type": "FB",
    "location": "FR",
    "organization": "CMA CGM"
}