👋 Cryptr API Qodex Collection
Discover an all-inclusive Qodex collection designed to encompass the expansive capabilities of the Cryptr API. You may find its documentation at docs.cryptr.co/api for a comprehensive understanding of its features and functionalities.📋 Prerequisites
- Download [Qodex]
- No prior knowledge is required. However you will need an
api_key_client_id
and anapi_key_client_secret
to follow this guide.
🗃️ Installing the Collections
Fork a collection
To get started, you will fork the collections and the environment into your workspace from [Cryptr’s public workspace] within Qodex.My Workspace,check
Watch original collectionto receive updates, and then click the
Fork Collectionbutton.
If you want to execute an API request, just navigate to the endpoint file (POST, GET, etc.) in the sidebar and select it.
- The information to provide will be listed in the Params and/or Body tab, you will just have to replace the values in the Value column.
- You can uncheck or check also the params that are not required and that interest you.
- Required parameters will be indicated by “(Required)” in the Description column.
💻 Environment variables
Let's start adding variables to your environment file: Make sure you have the variables below if you've forked the environment:- Variable called
my_domain
with the value of your organization's domain. - Variable called
api_key_client_id
with the value of your previously retrieved client_id. - Variable called
api_key_client_secret
with the value of your previously retrieved client_secret. → Set type to secret - Variable called
cryptr_service_url
with the value of URL.
- Click on No Environnment at the top right and choose your environment file:
🔑 How to get an access token
You must now generate a token.To generate a token, go back to your collection, in the sidebar click on the Collections button icon then on the name of your collection.
Get New Access Token
button
Use Token
button
🚀 How to use the access token to query the Cryptr API
- Queries use parameters you need
- Parameters not required can be unchecked
- When you send a request, the response is displayed as JSON
- When you already retrieved a token on the collection, you can use
inherit from parent
in any child request of it (even it's created)
Create an Organization
endpoint
Send button
at the top right
201
.