​
Setting up

Here are some important things to keep in mind when integrating with our APIs.

We currently use OpenAPI 3.0 specification to specify and document our APIs, so it will be easy for you to make requests and observe the responses.

The first steps to start the integration process are defined below.

​
User account creation

Disclaimer: Sandbox environment is intended for testing purposes only. When creating user accounts or inputting data, feel free to use fake or dummy information to complete onboarding faster. No real user data is required or recommended in this environment.

  • Visit our test environment: https://app.sandbox.rio.trade/en/register
  • Create an account by entering a phone number, including the country code (Example: +520000000000).
  • When the platform asks for the verification code, enter 123456.
  • Set your password and security question.
  • Once your registration is complete, log in to the platform using your registered credentials. Remember, the verification code is 123456.

​
API key generation

After completing the registration process in https://app.sandbox.rio.trade/en/register you must enter the application through https://app.sandbox.rio.trade/en/login with the username and password assigned, it is important to note that the verification code is 123456 and once on the platform; in the navigation menu go to Developer and API Keys to generate the respective key.

This is an example of the request:

curl -X 'GET' \
  'https://app.sandbox.rio.trade/api/users' \
  -H 'accept: */*' \
  -H 'x-api-key: test'

Remember to use the api key generated in the request headers by adding the x-api-key

​
User approval

The user approval process is carried out by the system administrators, therefore when creating a user the approval request must be made to the administrators through Slack or email.