Endpoint Construction

The structure for all Akana API Platform API endpoints for the current version is as follows:


For example, for the apps service the endpoint is as follows:


The basic URL, which is the same for all Akana API Platform services and methods, can be broken down as follows:

  • Scheme (https)
  • Host (api.atmos.phere)
  • Version (1)
  • Specific service/operation

There might also be one or more URL parameters, or an additional part to the URL. For example, the following includes two URL parameters and an extended URL path:


Here is an example of the above:


In some cases there might be additional query parameters. These are appended after a question mark at the end of the URL. For example, the following operation, GET search, includes a query parameter for the search expression:


Here is an example of the above:


Related Topics