API Documentation #reference
Number of APIs: 6
This template contains a boilerplate for documentation that you can quickly customize and reuse. The ((product name)) provides many API products, tools, and resources that enable you to ((add product value here)). To start using the ((add APIs here)), you need to - The ((product name)) API uses ((add your API's authorization type)) for authentication. Qodex uses API keys for authentication. You can generate a Qodex API key in the API keys section of your Qodex account settings. You must include an API key in each request to the Qodex API with the X-Api-Key request header. If an API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code. API access rate limits apply at a per-API key basis in unit time. The limit is 300 requests per minute. Also, depending on your plan, you may have usage limits. If you exceed either limit, your request will return an HTTP 429 Too Many Requests status code. Each API response returns the following set of headers to help you identify your use status: An HTTP In case you have questions, go through our tutorials ((link to your video or help documentation here)). Or visit our FAQ page ((link to the relevant page)). Or you can check out our community forum, there’s a good chance our community has an answer for you. Visit our developer forum ((link to developer forum)) to review topics, ask questions, and learn from others.How to use this template:
codespan - feel free to read and remove them.
Start with a brief overview of what your API offers.You can also list the APIs you offer, link to the relevant pages, or do both in this section.Getting started guide
List the steps or points required to start using your APIs. Make sure to cover everything required to reach success with your API as quickly as possible.The points given below are from The Qodex API's documentation. You can reference it to write your own getting started guide.
Authentication
Add details on the authorization keys/tokens required, steps that cover how to get them, and the relevant error codes.The details given below are from the Qodex API's documentation. You can reference it to write your own authentication section.Authentication error response
Rate and usage limits
Use this section to cover your APIs' terms of use. Include API limits, constraints, and relevant error codes, so consumers understand the permitted API usage and practices.The example given below is from The Qodex API's documentation. Use it as a reference to write your APIs' terms of use.
Header
Description
X-RateLimit-LimitThe maximum number of requests that the consumer is permitted to make per minute.
X-RateLimit-RemainingThe number of requests remaining in the current rate limit window.
X-RateLimit-ResetThe time at which the current rate limit window resets in UTC epoch seconds.
503 response
503 response from our servers indicates there is an unexpected spike in API access traffic. The server is usually operational within the next five minutes. If the outage persists or you receive any other form of an HTTP 5XX error, [contact support]Need some help?
Add links that customers can refer to whenever they need help.You can also document or add links to libraries, code examples, and other resources needed to make a request.
1. User - Get authenticated user
GET https://api.getpostman.com/me?foo=bar
2. Collections - Create a collection
POST https://api.getpostman.com/collections
3. Collections - Get a collection
GET https://api.getpostman.com/collections/{{collectionId}}
4. Collections - Delete a collection
DELETE https://api.getpostman.com/collections/{{collectionId}}
5. Collections - Update a collection
PUT https://api.getpostman.com/collections/{{collectionId}}
6. Collections - Get all
ENDPOINTS