Authorization

The authorization header is required for developers to be able to access all queries/mutations of the Rye API. The header can be obtained from the Rye console, Under Account → Access and Security, view and copy your API key.

The header is of the following format:

JSON
{
  "Authorization": "Basic << API Key here >>",
  "Rye-Shopper-IP": "<< Your IP address here >>"
}

Rye-Shopper-IP (Optional)

This header is required for making requests on behalf of the end user because some systems such as Shopify have fraud risk calculations based on the end user IP (ex: if the IP matches the billing address IP).

JSON
{
	"Rye-Shopper-IP": "103.123.5.23"
}

Rye-Shopper-IP header is required to use the submitCart mutation.


Where to find these headers

These headers can be found if you head to https://console.rye.com/graphql and click on the HTTP Headers tab at the bottom of the screen.