This section explains the prerequisites to consider when setting up a ReadMe SDK for the first time.

You must create a ReadMe account before you set up a SDK. A ReadMe account is required to configure any ReadMe SDK. You can create an account here.

Getting Started with ReadMe SDKs

With the ReadMe SDK, you can:

  • Simplify authentication by providing API keys directly in your docs and creating a unique API onboarding experience with Personalized Docs
  • See where developers get stuck as they’re trying to make their first API call and surface API insights to help them debug with API Logs

Here's an overview of how to set up ReadMe:

For Personalized Docs:

  • You create a webhook, which is an endpoint that will need to be set up within an application that has secure access to user data, that ReadMe will make a POST request to when an API consumer logs in to your documentation.
  • This endpoint will receive POST requests from ReadMe any time a user logs in, and will need to return a JSON object with information about the user, which will then be surfaced in the documentation.

For API Logs:

  • You add ReadMe middleware to your application.
  • The middleware will send to ReadMe the request and response objects that your server generates each time a user makes a request to your API. The entire objects are sent, unless you deny or allow specific keys from the request. We’ll send a HAR representation to the ReadMe service.
  • ReadMe uses these request and response details to create an API Metrics Dashboard which can be used to analyze specific API calls, monitor aggregate usage data, or identify error messages. If a user logs into your documentation, ReadMe will show them logs of the requests they made in My Requests so they can troubleshoot.

Available SDKs

Here’s a list of supported SDKs below. If the language or framework you use is not yet supported, let us know what you’re using!

You can also send API logs directly to ReadMe via our API.

PHP (Laravel)
Python (Django)
Python (Flask)
Ruby (Rails/Rack)

Additional Resources