Skip to main content

Getting started


Overview​

Welcome to the API documentation for connecting 3rd party systems with TheFork Manager platform (known as TFM).

By leveraging our API, external companies enable their restaurant clients to synchronize crucial data and processes between their systems and TheFork ecosystem.

Whether you're a developer tasked with implementation or a product manager exploring integration possibilities, this documentation provides comprehensive insights into leveraging our API effectively. From authentication protocols to endpoint usage and data schemas, we aim to equip you with the knowledge and tools necessary to seamlessly integrate your systems with TheFork Management platform.


Versioning​

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.


Rate limiting​

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.


Error codes​

TheFork employs standard HTTP response codes to indicate the success and failure of API requests.

Certain errors may occur on any endpoint and should be handled globally. These include:

  • 429 - Rate limit
  • 401 - Invalid API key / Bearer token
{
    "statusCode": 401,
    "error": "Unauthorized"
}
  • 500 - Internal server error
{
    "statusCode": 500,
    "error": "Internal server error"
}