API Documentation #reference

API Documentation #reference integration on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from Codat.

API Documentation #reference | Codat - Postman Collections Workspace | API documentation

Collections

Collections API Documentation #reference integration on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from Codat.

Collections API Documentation #reference | Codat - Postman Collections Workspace | API documentation

<h2>👋 Introduction</h2>

<p>Welcome to the API demos workspace. This workspace contains Qodex collections that you can quickly demo and share our APIs with consumers.</p>

<h2>🚀 Getting started with this workspace</h2>

<p>In this workspace, you&#39;ll find two types of Qodex collections that help our customers understand and consume our APIs.</p>

<h5><strong>Reference</strong> collections</h5>

<p>These collections contain all the requests and documentation associated with that API. Please share this with customers to provide a comprehensive overview of our APIs and how to use them.</p>

<h5><strong>Blueprint</strong> and <strong>workflow</strong> collections</h5>

<p>These collections illustrate real-life use cases where our APIs can be used. Please use these to demo our API capabilities to consumers.</p>

<h5><strong>Environments</strong></h5>

<p>Environments are set up to manage variables like base URLs, API keys, and tokens whose values you can change depending on the context of your work (e.g., development, staging, production).</p>

<h2><strong>⭐️</strong> Best practices</h2>

<p>Here are some best practices to follow when you demo and share APIs with customers:</p>

<ul>
<li>Ensure that no API keys are exposed during the demo. Always use [environment variables] for authentication.</li>
<li>When sharing environments with customers, ensure it doesn&#39;t contain any API keys.</li>
<li>If you need to share the same collection with customers repeatedly, consider sharing it using a [public workspace] Alternatively, you can [export and share] collections and environments.</li>
<li>You can use the [Qodex visualizer] to demo key request responses.</li>
</ul>

<h2>🛟 Help and support</h2>

<p>If you have any questions or suggestions, please don&#39;t hesitate to reach out to your manager.</p>


Codat - Postman Collections

Github

Twitter

Developer Website

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

Collections

1. Get a collection

2. Create a collection

3. Delete a collection

4. Update a collection

5. Get all collections