Skip to main content

Documentation Index

Fetch the complete documentation index at: https://gr4vy.radial-commerce.com/llms.txt

Use this file to discover all available pages before exploring further.

Before your application can communicate with the API you will need to create a new API key. The API handles authentication using a signed JSON Web Token (JWT) which is passed in a HTTP header. 
curl -X GET https://api.example.gr4vy.app/transactions \
  -H "authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIi..."
We recommend you use an SDK. Our SDKs makes the process of generating a token a lot easier and is probably available in your preferred programming language. We will get to this in the next step.

​
Create a new API key

To use the API you will need to generate a new API key. Head over to your dashboard and visit the Integrations page. API key dashboard On this page, click the Add API key button select a name for your key. The name is purely for you to track what key is for what integration. You will need to store the downloaded key securely as we will not store this key for you.
Learn more about private keys, key-pairs, and JWT in our in-depth guide on authentication.

​
Summary

In this step you:
  • Learned about API authentication.
  • Created a new private key for the API.
  • Stored this API key in a secure place where your application can access it.