Endpoint Construction

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

https://{hostname}/api/{service}

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

https://{hostname}/api/apps

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:

https://{hostname}/api/apps/{AppID}/members/{UserID}

Here is an example of the above:

https://{hostname}/api/apps/app10017.acmepaymentscorp/members/user10021.acmepaymentscorp

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:

https://{hostname}/api/search?{q}={SearchExpression}

Here is an example of the above:

https://{hostname}/api/search?q=payments&count=2

Related Topics