Qodex.ai

Postman Library API v2 docs

Number of APIs: 5

Manage books in the Qodex library using this API. This API is designed to teach the basics of using APIs and Qodex!

Note that all non-permanent collection books are automatically deleted on a three-day rolling basis

Permanent collection books

Some books are part of the permanent collection and cannot be edited or deleted. These books have the property isPermanentCollection: true

Authorizing requests

This API requires Authorization to make POST, PATCH, and DELETE requests.

You will need to set the API key in the collection variables to Qodexrulz in order to make those requests.

In the real world you would generate an API Key with an API's developer portal service. This is just a training API so we have provided an API key for you!

Learn more about authorizing API requests in Qodex [here]

This is a public API!

Any book you add or update will be publicly visible to all users of this API. Please be respectful and follow these rules:

  • Only modify books you have added yourself
  • Understand that books in this API may be deleted at any time

What's different from the old [Qodex Library API]

The old Library API was used in the [Qodex Classroom Program] modules. We made some improvements for v2:

  • API Key Auth for POST/PATCH/DELETE requests. Practice authorization!

  • POST/PATCH requests now return book info such as id. This enables possibilities with scripting based on the response.

  • Dedicated public workspace and docs. You can view this API's schema from the API tab in the public workspace. Easily find and fork this API or docs by searching Qodex Library API v2

  • Automatic cleanup. Non-permanent collection books are automatically deleted on a rolling three-day basis.

  • Profanity filters. Cleans up book titles and author names

  1. books-{id} - Update a book by id PATCH {{baseUrl}}/books/:id

  2. books-{id} - Delete a book by id DELETE {{baseUrl}}/books/:id

  3. books - Get books GET {{baseUrl}}/books

  4. books-{id} - Get a book by id GET {{baseUrl}}/books/:id

  5. books - Add a book POST {{baseUrl}}/books