Recipok public API and access tokens
Integral plan
How to create and revoke API tokens, which data can be read and written, and where to find the documentation for your IT person.
What it is for
The public API is the door that lets another program read and write in your Recipok account without anyone copying data by hand: your online shop creating orders, your management software collecting delivery notes, a spreadsheet checking the stock every morning.
Each program gets in with a token, a long key that you create, give to whoever builds the connection and can revoke whenever you like. This article is for the owner who has to create that key and for the IT person who is going to use it.
Before you start
- Tokens are part of the Integral plan.
- They are created by a user with the manager or administrator role.
- You need someone to program the connection: whoever maintains your management software or your IT person. If you don’t have anyone, see Connect Recipok to your invoicing, accounting or POS: we also build custom integrations.
Where it is
In your account menu, at the top right, go to Integrations and open the API Token tab. The Developer Options screen shows the same information; on a plan other than Integral it only describes the API and warns you that your plan doesn’t create tokens.
1API base URL: https://api.recipok.com · Authentication header · Example request
View full API documentation
| Name | Status | |
|---|---|---|
| Online shop | Stored securely | 2Delete |
Token name: E.g.: Zapier Integration, Local Development, etc.
3Generate token
- 1The details for your IT person: the API address, the header where the token goes and an example ready to copy.
- 2Each token has a name: so you know which program uses it and which one to delete.
- 3Generate token creates the key and shows it to you only once.
Creating a token
Give it a name
In Create new token, write what it is for in Token name: “Online shop”, “Accountant”, “IT person’s tests”. One token per program.
Click Generate token
The Copy this token now notice appears. Click Copy and keep it somewhere safe, or send it straight to whoever will build the connection.
Confirm
When you click Confirm the token is hidden for ever. In the list it shows as “Stored securely”: Recipok stores it encrypted and nobody can read it again.
Revoking tokens
- To withdraw a key, delete it from Your tokens with Delete. The program that was using it can no longer get in, straight away.
- The administrator also sees Tokens of other users, with their owner, and can use Revoke token on any of them. Useful when someone leaves the business.
A token gives access to your business’s data. Don’t paste it into emails to several people or into shared documents, and create a different one for each program: that way you can cut one off without stopping the others.
What a program can do with the API
| Area | Examples |
|---|---|
| Recipes | Look up recipes with their ingredients, formats, prices and VAT, and nutrition information. |
| Ingredients and suppliers | Read and create ingredients; look up suppliers. |
| Purchasing and stock | Record goods-in and check or adjust stock. |
| Production | Create production orders, assign lots and complete them. |
| Sales | Create sales orders, mark them as delivered, record dispatches with their lots and look up or create customers. |
| HACCP | Record and look up HACCP records and locations. |
For your IT person
- The full technical documentation is at api.recipok.com/api/doc (View full API documentation button). It can be read in several languages.
- The API responds on its own domain: requests sent to the address you use to log in to Recipok don’t reach it.
- The token goes in the authentication header shown on screen, in every request.
- Imperial units, optional. If the integration works in pounds, ounces or degrees Fahrenheit, it can ask for them with the X-Unit-System header:
imperial_uk,us_customary,account(the units set up in your account) ormetric. Without that header everything stays in metric, as always.
Before connecting a new program to your live account, ask your IT person to test with a small amount of data and check in Recipok what it has created. Questions about the API are answered in the support chat.