ready2order Public API (R2-2024.43.1-patch3)

The API of ready2order uses tokens for authentication. These tokens have to be set in the Authorization header of your request. (Please note the correct spelling of Authorization in your request header!)

This token identifies the developer who is using the API. With that token you can request permissions to existing ready2order accounts. To start, please go to api.ready2order.com, sign up as a developer and follow the instruction in the email. Your Developer-Token will be included in that email!

The Developer-Token is only needed for:

• requesting Grant-Access-Token

This token identifies the request of developer who wants to use the API. With that token you can request permissions to existing ready2order accounts.

The Account-Token is the key to access account data like products, product groups, customers and more. To interact with data of ready2order accounts you must use this token!

Initially you have to request a unique Developer Token for your application at api.ready2order.com. Therefore, call the following URL with the following request data. You don’t need to set the Authorization header by now, as you don’t have your token yet.

With your Developer token you can request Grant-Access-Token. Call POST /v1/developerToken/grantAccessToken endpoint to request that. You can specify the callbackUri in this step (see detailed description below). In the response you will get the grantAccessToken but also the full URI (field grantAccessUri) you can use for approving the access.

Call the grantAccessUri and login with the credentials of an existing ready2order account. After login, the user will see a confirmation box to grant your application access. If it is specified we will redirect to callbackUri specified in previous step after the Grant-Access-Token is approved or denied by the Account. Example of callbackUri: http://www.ready2order.com?your-extra-param=123 We will then redirect to: http://www.ready2order.com?your-extra-param=123&accountToken=__ACCOUNT_TOKEN__&grantAccessToken=__GRANT_ACCESS_TOKEN__&status=approved|denied Grant-Access-Token has expiration set! You have 10 minutes to get this token approved by the Account. Otherwise you would need to create new one!

You can make up to 60 requests per minute per Account-Token. If you exceed the rate limit you will see the following response.

    {
        'error':true,
        'http':429,
        'code':'rateLimitExceeded',
        'rateLimitRequestPerMinute':60,
        'rateLimitRequest':60,
        'rateLimitMinutes':1,
        'msg':'You have reached the rate limit of 60 requests per minute. You were blocked for at least 1 minutes! Try again later!'
    }

ready2order supports webhooks for the best experience.

• product.created is triggered whenever a new product is created
• product.updated is triggered whenever an existing product is updated
• product.deleted is triggered whenever an existing product is deleted
• productGroup.created is triggered whenever a new product group is created
• productGroup.updated is triggered whenever an existing product group is updated
• productGroup.deleted is triggered whenever an existing product group is deleted
• invoice.created is triggered whenever a new receipt (bill, invoice, payment-receipt, ...) is created
• orderItem.created is triggered whenever a gastro-order is booked on a table

Payloads

• for created and updated events we send the full objects to your webhook URL in the resource array, so you don't need to ask our API again.__
• for deleted events we provide you the IDs which has been deleted__

• To start with webhooks, you have to set up your webhook URL (see Webhook-section). You have to subscribe for events for which you want to be notified. Please see the list of available events above.