Add documentation: Clarify Authentication Methods and API Key Availability #8
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Authentication
This document explains how to authenticate with the API. Proper authentication is required to access any of the API endpoints.
Introduction
Currently, the API uses a combination of
X-API-Key
andX-API-Secret
for authentication. These headers must be included in every request you make to the API.Important: API keys are currently not self-service. Please contact the founders to request your API key and secret. We are working towards providing a self-service option in the future. Check back here for updates.
Quickstart
To make a successful API call, you'll need to include the
X-API-Key
andX-API-Secret
headers in your request. Here's an example usingcurl
: