In this section, you can read some general information.

Headers

Headers must include the following

Name	Value
X-PP-API	{YourAPIKey}@{YourAPISecret}
Content-Type	application/json

You can read the instructions on how to get your API Key and API Secret on our 🔑 Authentication page.

Response

Each JSON response will contain the following 3 elements

Name	Value
errors	(bool) true \|\| false
message	string
data	(any) will contain data relevant to the request

👍
Successful Response

{
    "errors": false,
    "message": "Informative message ...",
    "data": {
        "property1": "value1",
        "property2": "value2",
        ...
        ...
        ...
    }
}

❗️
Error Response

{
  "errors": true,
  "message": "No route found for \u0022GET \/partners-api\/v1\/undefined-route\u0022"
}