Connect Retool to ReadMe
You can connect to ReadMe and make it available as a REST API resource in Retool. Once complete, your users can write queries that interact with ReadMe data.
Requirements
All users for Retool organizations on Free or Team plans have global Edit permissions and can add, edit, and remove resources. If your organization manages user permissions for resources, you must be a member of a group with Edit all permissions.
To create a ReadMe resource, you need:
- Connection details for either the ReadMe API or Developer Metrics API.
- Your ReadMe API key.
ReadMe API connection and authentication
Retool authenticates with ReadMe using your API key and HTTP basic authentication.
1. Create a new resource
Sign in to your Retool organization and navigate to the Resources tab. Click Create new, then select Resource.
2. Select the resource type
Retool can connect to almost any API or database, and has built-in integrations for popular data sources. Select the REST API resource type.
3. Configure the resource
Specify a name and location for the ReadMe resource. Retool displays the resource name and type in query editors to help users identify them.
Configure the following settings for the resource.
General
| Setting | Description |
|---|---|
| Base URL | The base URL of the API. Use https://dash.readme.com/api/v1/ for the documentation API or https://metrics.readme.io/v2 for the metrics API. |
| URL parameters | URL parameters to include with every request. |
| Headers | HTTP headers to include with requests. |
| Extra body values | Additional body value to include with requests (except GET or HEAD requests). |
| List of cookies to forward | Cookies to forward. |
Authentication
| Setting | Description |
|---|---|
| Authentication | The type of authentication. Select Basic Auth. |
| Username | The API key. |
Click Test Connection to verify that Retool can connect to ReadMe. If the test fails, check the resource settings and try again. Testing a connection only checks whether Retool can successfully connect to the resource. It cannot check whether the provided credentials have sufficient privileges or can perform every supported action.
4. Save the resource
Click Create resource to complete the setup. You can then click either Create app to immediately start building a Retool app or Back to resources to return to the list of resources.
Wrap up
Your ReadMe resource is now ready to use. To interact with ReadMe data, select the resource in the query editor. You can specify the API endpoint to use when writing a query.