🚧

Any issues?

Integrations can be tricky! Contact support if you have any questions/issues.

Overview

If you're a developer, it's super easy to send your API logs to ReadMe, so your team can get deep insights into your API's usage. Here's an overview of how the integration works:

• You add ReadMe middleware to your Express server.
• The middleware sends to ReadMe the request and response objects that your Express server generates each time a user makes a request to your API. The entire objects are sent, unless you blacklist or whitelist keys.
• ReadMe extracts information to display in the API Metrics Dashboard, such as which endpoint is being called, response code, and error messages. It also identifies the customer who called your API, using whichever keys in the middleware you call out as containing relevant customer info.

Steps

Note these steps assume you are working in Node.js and Express:

1. Locate the file in your company's API codebase that contains your Express server. Often this file is named express.js or app.js. You can also search on the code snippet express()

2. From the directory of this codebase, run the following command in your command line to install the readmeio package from npm:

npm install readmeio --save

3. Load the readmeio module into your Express server. Usually near the beginning of the file, you will see several require statements. Add the following statement to that group:

const readme = require('readmeio');

4. Configure the following middleware function:

app.use(readme.metrics('<<user>>', req => ({
  id: req.<userId>,
  label: req.<userNameToShowInDashboard>,
  email: req.<userEmailAddress>,
})));

The readme.metrics middleware takes the following parameters:

• The ReadMe API Key
• A function that takes the req object and returns an object describing the user (in the case above, it just returns their apiKey to identify the caller)
• An options function that is not shown in the preceding middleware, but is discussed below.

Minimal middleware configuration

Here's the bare minimum you need to configure:

• The ReadMe API Key: The first parameter that readme.metrics takes is your doc project's ReadMe API Key. If you're logged in to these docs, this string is automatically populated in the proceeding middleware code.
  You can also see it here:
  KEYS:USER
  Otherwise, copy and paste it in from dash.readme.com/project//v/api-key.

• API caller identification: To identify the API caller, replace <userId>, <userNameToShowInDashboard>, and <userEmailAddress> with the appropriate properties in your req object that contain your user data. More details follow in the next section.

5. Paste the configured middleware into the file containing your Express server. Note that this middleware is not likely to be sensitive to order, so you can put it anywhere in the file after middleware that adds user properties to the request object. If you are new to Express, see How to Write Middleware for Express.js Apps

Identifying the API Caller

There are three fields that you can use to identify the user making the API call. We recommend passing all three to readme.metrics to make API Metrics as useful as possible. (If your req object doesn't have all this information, we recommend adding it via additional middleware prior to this.)

app.use(readme.metrics('<<keys:user>>', req => ({
  id: req.<userId>,
  label: req.<userNameToShowInDashboard>,
  email: req.<userEmailAddress>,
})));

Configuration Options

There are a few options you can pass in to change how the logs are sent to ReadMe. These are passed in an object as the third parameter to the readme.metrics.

const readme = require('readmeio');
const env = process.env.NODE_ENV;

app.use(readme.metrics('<<keys:user>>', req => ({
  id: req.<userId>,
  label: req.<userNameToShowInDashboard>,
  email: req.<userEmailAddress>,
}), {
  development: env !== 'production',
  bufferLength: 1,
  blacklist: <arrayOfSensitiveKeysToOmit>,
  whitelist: <arrayofKeysOnlyToSend>,
}));

📘

Blacklist/Whitelist in Request and Response Headers

As of [email protected], the blacklist and whitelist options will apply to both the headers and body.

For example, if you want to blacklist the authorization header and the apiKey body parameter from your requests, your blacklist will look like this:

blacklist: ['authorization', 'apiKey'],