👋 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 an api_key_client_secret to follow this guide.

Let's get started!

🗃️ 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.

Choose a fork label to distinguish it from the original, select My Workspace, check Watch original collection to receive updates, and then click the Fork Collection button.

You can now start using API requests once you have forked the collections.

The Cryptr API collection is organized into folders that classify the different API requests according to the endpoint. Thus, you will find all the organizations' methods in the Users Directories/Organizations folder.
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.

Save file cmd + S

You must now select your environment:

• Click on No Environnment at the top right and choose your environment file:

Once selected, a check icon appears next to the name of your environment file (in the left menu where the list of your environment files is displayed) to indicate the selected 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.

The collection has a parameter Authorizations where the fields are pre-filled, you just have to click on the Get New Access Token button

Once the authentication is successful, click on the Proceed button or wait a few seconds.

Now click on the Use Token button

You can now send API requests.

🚀 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)

Let's send our first request, we will take as an example the creation of an organization.

REMINDER: The collection is composed of folders containing several queries, these queries correspond to the actions you can perform.

Unfold the collection and navigate to the Create an Organization endpoint

Once the value of the name and allowedemaildomains[] parameters have been modified, you can click on the Send button at the top right

And that's it! The result of our request is displayed in JSON in the body (below the table of params). It is a success since the status is in 201.

🛟 Get support

If you encounter a bug or would like to propose a new feature, please get in touch with us.