Skip to content

Developer

Welcome to the developer guide for Analytics Platform.

In this guide you can find the following.

  • API documentation based on the OpenAPI (Swagger) standard
  • Library of generic SQL queries for data warehouses

API

Authenticaton

The AP API supports basic auth for client authentication. Basic auth is a straightforward HTTP challenge-response framework that requires a client to provide a username and password to gain access to a resource. To transmit these credentials, the pair is combined into a single string, encoded using Base64, and passed within the Authorization header of the request. Basic auth is supported in all major HTTP clients.

Architecture

The AP API adheres to many of the principles behind the REST architectural style.

  • Resources: The fundamental building blocks are referred to as resources. A resource can be anything exposed to the web, from a document to a business process.
  • Unique IDs: All resources can be uniquely identified by a URI, also referred to as a URL.
  • Content negotiation: JSON is the default request and response format. You can indicate that you are interested in a specific format by supplying an Accept HTTP header or a file extension.
  • HTTP methods: Interactions with the API requires the use of HTTP methods. Use a GET request to retrieve a resource, a POST request to create a new resource, a PUT request to update (replace) an existing resource and a DELETE request to remove a resource.