Skip to content

Fix auth header in API docs (access-token, not Authorization: Bearer) #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pimfeltkamp wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix auth header in API docs (access-token, not Authorization: Bearer) #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/api/authentication.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,14 @@ grant_type=authorization_code

## Access Tokens

The access token is used to authenticate API requests. Include it in the `Authorization` header:
The access token is used to authenticate API requests. Include it in the `access-token` header on every request:

```
Authorization: Bearer YOUR_ACCESS_TOKEN
access-token: YOUR_ACCESS_TOKEN
```

Note: the v1 Public API uses the `access-token` header, not the OAuth2-conventional `Authorization: Bearer <token>`. The AWS API Gateway in front of the production API rejects `Authorization` headers that aren't AWS-SigV4-formatted. (The internal V2 API uses Bearer; the v1 surface — which all official SDKs target — does not.)

### Token Expiration
Access tokens expire after a set period (indicated by `expires_in` in seconds). Once expired, API requests will return a `401 Unauthorized` response. Use the refresh token to obtain a new access token.

Expand Down
6 changes: 3 additions & 3 deletions docs/api/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,18 +30,18 @@ The Cryptohopper API uses **OAuth2** for authentication. You need to register an
Register your application on the Cryptohopper platform to receive a **client ID** and **client secret**. These credentials identify your application when making API requests.

### Step 2: Authenticate
Implement the OAuth2 authorization code flow to obtain an access token. This token is included in the `Authorization` header of every API request.
Implement the OAuth2 authorization code flow to obtain an access token. This token is included in the `access-token` header of every API request.

```
Authorization: Bearer YOUR_ACCESS_TOKEN
access-token: YOUR_ACCESS_TOKEN
```

### Step 3: Make Your First API Call
With a valid access token, you can make API requests. For example, to retrieve a list of your hoppers:

```
GET https://api.cryptohopper.com/v1/hopper
Authorization: Bearer YOUR_ACCESS_TOKEN
access-token: YOUR_ACCESS_TOKEN
```

The response contains a JSON object with your hopper data.
Expand Down