On this page
REST API & API Keys
from BusinessConnect other programs to PlanDocket with API keys and monitor API usage.
Under Settings → Developer → REST API you connect other programs (accounting, CRM, website, Zapier, or Make) to PlanDocket with API keys. Each key may only do what you allow. Requires the Business plan or higher and the "REST API" feature switched on. The endpoints themselves are described in the API reference of this documentation.
Connect a Program
The box "How to connect a program" shows everything the other program needs:
- API Base URL
- The address the program sends its requests to
- Header "Authorization"
- The program puts the API key into this header with every request
Create a Key
"Create API Key" adds a new key:
- Name
- A label you recognize the key by later, e.g. the name of the program
- What may the program do?
- Read only (fetch data, change nothing), Automation (Zapier, Make) (read data and set up webhooks), Read and change, Choose myself, or Full access
- Choose myself
- Decide area by area: No access, Read only, or Read & write. You cannot grant more than your own role allows
- Areas
- Among others Events, Contacts, Participants, Applications, Invoices and credit notes, Payments, Schedules, Tasks, Activity log, Manage webhooks, and Calendar subscription
- Full access
- Read and change everything, including future areas. Only super admins can grant full access
- More settings (expiry date, request limit)
- Optional Expiration Date and Requests per hour (100–10,000, default 1,000)
- Copy the key
- The key is shown only once. Enter it in the other program right away; if you lose it, create a new one
Manage Keys
Using the actions of a key:
- Switch off for now / Switch on again
- Pause access without deleting the key
- Create a new key
- The previous key stops working immediately; enter the new one in the connected program
- Hand over to someone else
- Super admins only. The new person becomes the owner, the key stays the same, and the connection keeps running without interruption
- Delete
- Programs that use the key lose access. Webhooks of this key are switched off
- Suspended
- Keys belong to the person who created them. If that person is deactivated, the key stops working immediately until a super admin hands it over or deletes it
API Usage
Settings → Developer → API Usage shows the calls of all keys:
- Statistics
- Requests (30 Days), Success Rate, Error Rate, and Avg. Response Time
- Filters
- All API Keys, All Statuses, Search endpoint, plus From and To
- Columns
- Time, API Key, Method, Endpoint, Status, Response Time, and IP Address
Tips
- Create a separate key for each connected program so you can switch it off on its own
- Choose "Read only" if the program only needs to fetch data
- For a calendar subscription (see Calendar), create a key that allows only the area "Calendar subscription"
Notes
- Requires the Business plan or higher, the "REST API" feature switched on, and the permissions "View settings" or "Edit settings"
- Only the person who created a key and super admins can change it