<h2>👋 Cryptr API Qodex Collection</h2>

Discover an all-inclusive Qodex collection designed to encompass the expansive capabilities of the Cryptr API. You may find its documentation at <a href="https://docs.cryptr.co/api">docs.cryptr.co/api</a> for a comprehensive understanding of its features and functionalities.

<h2>📋 Prerequisites</h2>

<ul>
<li>Download [Qodex]</li>
<li>No prior knowledge is required. However you will need an <code>api_key_client_id</code> and an <code>api_key_client_secret</code> to follow this guide.</li>
</ul>

Let&#39;s get started!

<h2>🗃️ Installing the Collections</h2>

<h5>Fork a collection</h5>

To get started, you will fork the collections and the environment into your workspace from [Cryptr’s public workspace] within Qodex.

<img src="https://content.pstmn.io/71d87941-9867-44e0-b9b0-adf2e6bf6ff4/Zm9ya19jb2xsZWN0aW9uLnBuZw==" alt="Fork%20collection" width="280" height="301">

<img src="https://content.pstmn.io/b0ef5353-4f98-42b6-86ed-fa8c6464d47a/Zm9ya19lbnZpcm9ubWVudC5wbmc=" alt="Fork%20environment" width="280" height="246">

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

<img src="https://content.pstmn.io/4e8920a6-f257-453a-a9b5-03968ae78140/Zm9ya19mb3JtLnBuZw==" alt="Fork%20form" width="280" height="289">

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&#39; 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.

<ul>
<li>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.</li>
<li>You can uncheck or check also the params that are not required and that interest you.</li>
<li>Required parameters will be indicated by “(Required)” in the Description column.</li>
</ul>

<img src="https://content.pstmn.io/1baae56b-da51-4605-9926-4813e68d8fa9/Y29sbGVjdGlvbi5wbmc=" alt="Collection" width="280" height="327">

<h2>💻 Environment variables</h2>

Let&#39;s start adding variables to your environment file:

Make sure you have the variables below if you&#39;ve forked the environment:

<ul>
<li>Variable called <code>my_domain</code> with the value of your organization&#39;s domain.</li>
<li>Variable called <code>api_key_client_id</code> with the value of your previously retrieved client_id.</li>
<li>Variable called <code>api_key_client_secret</code> with the value of your previously retrieved client_secret. → Set type to secret</li>
<li>Variable called <code>cryptr_service_url</code> with the value of URL.</li>
</ul>

Save file cmd + S

<img src="https://content.pstmn.io/67726132-003b-484a-869d-beeedc3633d4/ZW52aXJvbm1lbnRfdmFyaWFibGVzLnBuZw==">

You must now select your environment:

<ul>
<li>Click on No Environnment at the top right and choose your environment file:</li>
</ul>

<img src="https://content.pstmn.io/0b2b47b9-a2e3-435a-b40e-a67e52190669/ZW52aXJvbm1lbnQucG5n" alt="Choose%20environment%20file" width="280" height="189">

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:

<img src="https://content.pstmn.io/ed960170-f15c-4b41-989c-57e4ed2c79bd/Y2hlY2tfZW52aXJvbm1lbnQucG5n" width="280" height="211">

<h2>🔑 How to get an access token</h2>

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.

<img src="https://content.pstmn.io/a1a53182-61f9-499a-a810-00b0dc3816dc/bmF2aWdhdGVfdG9fZ2V0X2FuX2FjY2Vzc190b2tlbi5wbmc=" alt="Navigate%20to%20get%20an%20access%20token" width="280" height="208">

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

<img src="https://content.pstmn.io/be4060aa-27c2-4a7f-81cf-bdd54b739856/Z2V0X25ld19hY2Nlc3NfdG9rZW4ucG5n" alt="Get%20New%20Access%20Token">

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

<img src="https://content.pstmn.io/5ccea6a1-b94a-4b76-a463-5b2ba1e979d7/YXV0aGVudGljYXRpb25fY29tcGxldGUucG5n" width="439" height="261">

Now click on the <code>Use Token</code> button

<img src="https://content.pstmn.io/3cc78ba1-c603-4313-adc6-aa9885c7a4a6/dXNlX3Rva2VuLnBuZw==">

You can now send API requests.

<h2>🚀 How to use the access token to query the Cryptr API</h2>

<ul>
<li>Queries use parameters you need</li>
<li>Parameters not required can be unchecked</li>
<li>When you send a request, the response is displayed as JSON</li>
<li>When you already retrieved a token on the collection, you can use <q>inherit from parent</q> in any child request of it (even it&#39;s created)</li>
</ul>

Let&#39;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 <code>Create an Organization</code> endpoint

<img src="https://content.pstmn.io/13823d61-2088-46f7-84b2-2fec8fa9eb65/Y3JlYXRlX2FuX29yZ2FuaXphdGlvbl9yZXF1ZXN0LnBuZw==">

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

<img src="https://content.pstmn.io/f749b7dc-4017-4838-aec5-13c8c8d141fd/c2VuZF9jcmVhdGVfYW5fb3JnYW5pemF0aW9uX3JlcXVlc3QucG5n" alt="Send%20request">

And that&#39;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 <code>201</code>.

<img src="https://content.pstmn.io/635a350a-7dbd-47a4-80e5-470343e8df8f/Y3JlYXRlX2FuX29yZ2FuaXphdGlvbl9yZXNwb25zZS5wbmc=">

<h2>🛟 Get support</h2>

If you encounter a bug or would like to propose a new feature, please <a href="https://support@cryptr.co">get in touch with us</a>.

Cryptr

Github

Twitter

Developer Website

Cryptr projects on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from Cryptr.