PlanDocket

Client libraries

You do not need a special library: every programming language can call the REST API directly. If you prefer a ready-made client, generate one from our OpenAPI file in a minute.

  1. 1 Download the OpenAPI file (or copy its address).
  2. 2 Run the generator for your language (examples below).
  3. 3 Use the generated client with your API key.

The OpenAPI file

The OpenAPI file describes every endpoint, field, scope and error of the API in a standard format. It is always up to date, because it is built from the same data as this documentation.

Machine-readable description of all endpoints (OpenAPI 3.1) for client generators, Postman and Swagger UI.

Address of the OpenAPI file

https://docs.plandocket.com/en/openapi.json

With OpenAPI Generator

OpenAPI Generator creates clients for more than 50 languages. With Docker installed, one command is enough:

docker run --rm -v "$PWD:/local" openapitools/openapi-generator-cli generate \
  -i https://docs.plandocket.com/en/openapi.json \
  -g php \
  -o /local/api-client

Replace the language name to get other clients, for example typescript-fetch, java, csharp or go.

Import into API tools

Postman, Insomnia, Bruno and Swagger UI can import the OpenAPI file directly. You then get every request ready to send, grouped by resource.

In Postman: Import, then paste the address of the OpenAPI file, then set the variable for your API key.

Authentication in the generated client

Set your API key as bearer token (header Authorization: Bearer YOUR_API_KEY). The generated clients offer a setting for it, usually called accessToken or bearerToken.

Authentication