Overview

Environments

The Relograde API has two environments:

• Production
• Sandbox

To use the production environment your account needs to be verified. The sandbox environment can be used with an unverified account. The sandbox environment mimics the production environment but does not use real money. Prices may be different in the sandbox environment for unverified accounts.

Obtaining API Keys

1. Log in or register to the Relograde Console
2. Navigate to the profile icon on the top right
3. Click on “Company”
4. Click on “API keys”
5. Generate keys for either Sandbox or Production environment

note

Note: Both environments have the same paths

Authentication

The API uses Bearer token authentication. Include your API key in the Authorization header with all requests.

Authorization: Bearer <Token>

Whitelist

Restrict API access to designated IP addresses. The following configurations are supported:

• Single IP Address: 192.168.1.1
• Multiple IP Addresses: 192.168.1.1, 192.168.1.2
• CIDR Range: 192.168.1.0/24 (encompasses 192.168.1.0 to 192.168.1.255)

note

• Leave the field empty to permit access from any IP address.
• Use commas to delineate multiple entries.
• Only IPv4 addresses are supported.

URL

Relograde API urls adhere to the following structure:

{BASE_URL}/api/{VERSION}/{RESOURCE}

Base url:

https://connect.relograde.com

Current version:

1.01

Examples:

https://connect.relograde.com/api/1.01/account

https://connect.relograde.com/api/1.01/brand

https://connect.relograde.com/api/1.01/order

https://connect.relograde.com/api/1.01/product

Rate Limits

Environment	Requests per minute
Sandbox	60
Production	60

Error Handling

Error Codes

Status	Code	Description
400	bad_request	Invalid request
401	unauthorized	Missing or invalid API key
402	payment_required	insufficient balance
403	forbidden	IP not whitelisted
404	not_found	Item not found
429	rate_limit_exceeded	Too many requests
500	server_error	Internal server error