Quick Start

The Platform API enables you to interact with your Pool Report System information. The APIs are designed around RESTful principles, and return JSON in response to HTTP requests.

Headers

A typical request to the API includes the following headers:


{
    Accept: application/json
    Authorization: Bearer {API_Token}
}
  • Accept : Every request must include a Accept header.
  • Authorization : An API Token is required to identify and authenticate your application. An exception is when you wish to perform actions outside of a specific application, such as creating a new company (sign up).

Authentication

Personal Access Tokens


While in developent or lingering, you can use personal access tokens to authenticate to the application

To get a personal access token :
  1. Log in to your account.
  2. Go to the Developer Settings.
  3. Click on create new personal access token.

OAuth Authentication Tokens


Pool Report System is fully compatible with the OAuth2 standard. You can read more about it at OAuth2 Documentation

To create a new OAuth Client:
  1. Log in to your account.
  2. Go to the Developer Settings.
  3. Click on create new client.

Url Encoding

When sending requests over HTTP, it is required that you encode your URLs into a browser-readable format. urlencoding replaces unsafe non-ASCII characters with a % followed by hex digits in order to ensure readability.