Information about the API

Information about the API

Here you can find information about the API/interface and how you can easily request it on our website.

What is API used for?

API is short for "Application Programming Interface." It is an interface through which multiple apps/websites can communicate with each other and exchange information.

How is an interface created?

An API is an open interface that connects different apps, programs, and programming languages. It facilitates communication and exchanges information between these different programs. The information is exchanged in a so-called JSON format (one program asks the question, and the other responds with the value).

What is a developer token?

Developer and account tokens are specific to ready2order and are required for client authentication. They serve as a "secret word" between the client and ready2order to ensure the authenticity of requests via the API.

The developer token is required for the API integrator. This token can be used to create account tokens. An API integrator is not tied to an account and can create account tokens in different accounts for different customers , provided they receive permission to do so. Imagine a service provider that manages online shops for different companies.

What is the account token?

The account token is used for identification purposes. It is required to query data from a specific account.

Which software is the r2o API compatible with/can it connect to?

We provide official libraries for API communication for PHP and NodeJS.

What is the process from application to access?

API application on the website

  1. Visit our ready2order website
  2. Scroll all the way down. Under "Resources," you'll find the link to the API
  3. Here you can request API access
  4. Fill in all necessary information
  5. The developer token will be sent via email to the applicant, i.e. you
  6. Next, you log in to your account. An account token is generated using a link in the email.
  7. API queries can be created with account tokens.
It is important that you have an account with ready2order so that you can request your developer token at ready2order .

Manage API access in the Admin Interface

  1. Open the Admin Interface
  2. Go to settings - API access
  3. Click on invoices
  4. All existing API access permissions can be seen here

API FAQs

Can I enter a purchase price via the API?

No

Can I change the payment method of an existing invoice using the API?

No

Can I create a payment receipt using the API?

No

Which IP address do we need to activate so that r2o can access the API?

We do not have fixed IP addresses for the webhooks.

Although your request is legitimate, we are unfortunately unable to accommodate it at the moment as we are a cloud-based service and would require a lot of changes to our current configuration.

We don't offer ready-made web shops. However, you can create one using our API and a developer/partner of your choice.
The following section is only relevant if you used the API before January 2022.

Process change for API integrations - January 2022

Since January 2022, there has been a change to the process for initially linking third-party apps to ready2order accounts.

Who is affected by the changes?

  1. If you started developing a third-party app integration before this time, the authentication process has changed.
  2. If you have an existing integration that regularly revokes access, the integration must be updated to the new process.

What is this document?

This document will guide you through the necessary changes that need to be made in third-party apps to ensure that the initial authentication process for ready2order accounts continues to work.

To work with ready2order's API, it is necessary to request an API token for a specific ready2order account. To receive this API token, the ready2order customer must be redirected to a specific page where they must log in. After successfully logging in, the ready2order ready2order must agree to allow the third-party app to access their account data.

Which part is affected by this change?

The process for obtaining the initial API developer token has changed.

If you have a reason to revoke the API Developer Token, the process for obtaining a new one will be changed as described below.

What has changed?

Old process

A third-party developer redirected the ready2order customer to this page.

This process is deprecated and was decommissioned on February 28, 2022.

New process

  1. Use your developer token (sent to you via email when you registered as an API developer) to request a temporary grant access token
If you have lost the original email and have not saved the token in the configuration of your third-party app, please contact ready2order support.

POST https://api. ready2order .com/v1/developerToken/grantAccessToken

Authorization: {DEVELOPER_TOKEN}

Accept: application/json

{

"authorizationCallbackUri" : null|string

}

Optionally, the authorizationCallbackUri parameter can be specified in the request body. This parameter must contain a valid, publicly accessible URL to which we will redirect the ready2order customer after approval or rejection. If specified, we will redirect the ready2order customer to this page with the following parameters.

GET https://example.com/redirect-endpoint?status=approved|abgelehnt&accountToken=${ACCOUNT_TOKEN}&grantAccessToken=${GRANT_ACCESS_TOKEN}

Please remember to compare the grantAccessToken passed to the authorizationCallbackUri with the grant access token on your site to avoid unexpected results.

  1. Using the grantAccessUri and redirecting the ready2order - customers to this page.

Next, the ready2order customer will be asked to log in and can either grant or deny access to your app.

If the ready2order customer has consented and no authorizationCallbackUri has been specified, the ready2order customer will only see the account token for using the API.

If the ready2order customer has agreed and an authorizationCallbackUri has been specified, the ready2order customer is redirected to the specified address and the account token for using the API can be read from the query parameter accountToken .

For more information, see the API documentation.
If the account token becomes invalid for any reason, the process must be repeated to obtain an active account token.
We also answer your support requests via chat. Click here to access the chat.

How did we do?