Developers

ReadMe Documentation

Welcome to the ReadMe Documentation, where you'll find comprehensive guides and community support to help you start working with ReadMe as quickly as possible!

Get Started

Authentication

Authentication

Like almost every API, the ReadMe API requires you provide an API key in your requests to get responses. A ReadMe documentation project comes with an API key that anyone who uses the API to control the docs needs to use.

The ReadMe API uses basic authentication. Your API Key can be found by:

  1. Navigating to Configuration
  2. Selecting API Key

Authentication Types

If you are using the Authorization header, the API Key will need to be encoded.
If you are using the -user option, your project API key is your username and the password field is left blank.

If you're unfamiliar with API authorization, then follow these steps to get your API key and make a first test request to your project:

  1. Navigate to the API key of your project settings on the dash at dash.readme.io/project/<your project>/api-key.
  2. Copy the API key (it is automatically generated when you first create the documentation project).
  3. If you don't already have Postman, download it at https://www.getpostman.com/downloads/.
    You can use many different REST clients to make API requests. For example, in the command line, you can install and use cURL. For these instructions, we use Postman.
  4. Open the Postman app and create a new request. You can fill in the new request's name, description, and collection with any text, for example, "test."
  5. In your new request, insert the following endpoint into the field next to GET:

https://dash.readme.io/api/v1/changelogs?perPage=10&page=1

  1. In the Authorization tab (below the box where you inserted the endpoint), select Basic Auth from the Type dropdown.
  2. Insert your API Key into the Username field. Leave the Password field blank.
  3. Click Send.
    The response appears in the lower pane. For example:

The response shows a list of the 10 most recent posts in your project's Changelog.

Updated 5 days ago


Authentication


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.