Getting started
The first step is to create a Rye account. Starting off with creating an account only in the staging environment is a common workflow, but keep in mind that in order to go live you will eventually need to create an account in the production environment as well. 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:
Making API calls
If you are making direct GraphQL requests using your own GraphQL client, then you will need to manually specify which endpoint to make those requests against. The correct GraphQL endpoint for each environment can be found in the “Tech specs” section below. If you are using one of our Rye SDK, the library uses this value to determine which endpoint it should hit under the hood.Tech specs
Below you can find the GraphQL 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.Environment | Console | GraphQL Endpoint |
---|---|---|
Staging | https://staging.console.rye.com | https://staging.graphql.api.rye.com/v1/query |
Production | https://console.rye.com | https://graphql.api.rye.com/v1/query |