​
Overview

All API calls occur in either our staging or production environment. Our staging environment acts as a sandbox. Developers can safely work on their integration without the risk of placing real orders or charging real credit cards. The staging environment is where all new API integrations begin. After working on your integration in the staging environment, you can go live and launch to customers using our production environment. In production, it is possible to charge real payment methods and purchase products from the various marketplaces the REST API supports. Both environments are completely isolated from each other to ensure security. A cart belonging to a customer in your production environment is inaccessible in the staging environment, and vice versa. Each environment uses a separate API key for authentication.

​
Switching Enviroments in Console

Once you are signed in the Console to either environment, you will see a switch in the top-right corner of the page which tells you which environment you are currently signed in to. Clicking this switch will swap your browser between each environment. Below you can see an example of what this looks like when signed in to the staging environment: Keep in mind that because each environment is isolated from the other, your authentication headers will be different for each environment. Using your staging API key to make requests to our production API will result in an authorization error, and vice versa.

​
API Endpoints by Environment

Below you can find the REST API endpoints for each environment. When making requests you will need to provide authorization headers for your account in that environment for your requests to run successfully.
EnvironmentConsoleBase API URL
Staginghttps://staging.console.rye.comhttps://staging.api.rye.com/api/v1/
Productionhttps://console.rye.comhttps://api.rye.com/api/v1/

​
Differences Between Staging and Production Environments

  • Order Placement
    • No actual orders will be placed through the /confirm endpoint in staging. You can use this to test order flows safely without affecting live inventory or fulfillment.
  • Payments
    • Payments in the staging environment use Stripe test cards. No real financial transactions are processed.
    • You can find a full list of supported Stripe test cards in the official Stripe documentation: Stripe Test Cards
    • Use the following Stripe API key to tokenize credit card information: pk_test_51LgDhrHGDlstla3fdqlULAne0rAf4Ho6aBV2cobkYQ4m863Sy0W8DNu2HOnUeYTQzQnE4DZGyzvCB8Yzl1r38isl00H9sVKEMu

​
Rate Limits

The default limits are 5 requests per second and 50 requests per day.