👋 Introduction

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

🚀 Getting started with this workspace

In this workspace, you'll find two types of Qodex collections that help our customers understand and consume our APIs.

Reference collections

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.

Blueprint and workflow collections

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

Environments

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

⭐️ Best practices

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

• Ensure that no API keys are exposed during the demo. Always use [environment variables] for authentication.

• When sharing environments with customers, ensure it doesn't contain any API keys.

• 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.

• You can use the [Qodex visualizer] to demo key request responses.

🛟 Help and support

If you have any questions or suggestions, please don't hesitate to reach out to your manager.