Welcome to the API documentation for connecting POS with TheFork Manager platform
By leveraging our API, POS enable their restaurant clients to synchronise crucial data and processes between their systems and TheFork ecosystem.
How the integration works
The customer arrives at the restaurant.
Restaurant marks the booking as “Arrived” or “Seated” in TheForkManager.
TheForkManager sends a message that triggers opening the table in the POS.
Order are added in the POS.
The customer asks and pays the bill.
Table is “closed” in the POS.
Bill details are sent back to TheForkManager and attached to the reservation.
Key advantages of the integration
Operational optimisation
During services, Restaurants don’t have to juggle between two systems and perform certain actions twice (e.g., seat table)
Collect data
The integration allows transfer of customer’s spend data into TheForkManager once the customer has left and been marked in the POS.
Get started with the integration
1. Managing credentials
Get API key for POS API v1 before using our endpoints.
2. Create the secret token
You have to generate and provide the restaurant a token.
3. Testing Environment
We need to create a test restaurant identified by a Customer to link to your POS.
4. You’re all set!
A new activation button for POS will be added to TFM Integrations page. Link your restaurant after the test.
Do’s and Don’ts with the integration
What you can do
What you cannot do
More about the document
Rate limiting is currently enforced at the default level as outlined in your contract.
Feel free to reach out to us to discuss any necessary revisions based on your specific requirements.
We use one version for the whole API, not one version per endpoint.
Any breaking change to the contract of one or more endpoints will introduce a new version for our API. We will stop supporting the previous version after 6 months.