Skip to content

Commit

Permalink
Merge pull request #52 from scinote-eln/ma_SCI_10775
Browse files Browse the repository at this point in the history
Add API key documentation [SCI-10775]
  • Loading branch information
artoscinote authored Jul 3, 2024
2 parents 4bb290a + d7cd9db commit a13f7e6
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions source/index.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,19 @@ iss | Text identifier of the token issuer
exp | Token expiration time
sub | The ID of the current authenticated user

## Alternative: API Key authenticaton

<aside class="notice">
The API key authentication feature needs to be enabled on your instance to use this option.
</aside>

If your instance has the API key functionality enabled, you can generate the API key in your user profile settings in SciNote (/users/edit). To authenticate via API key, add the following header to all requests:

`Api-Key: qwerty123456...`


The API key expires after one year. You can revoke the API key at any time in your user profile settings.

# Pagination

SciNote API uses pagination as specified here [JSON API](http://jsonapi.org/format/#fetching-pagination)
Expand Down

0 comments on commit a13f7e6

Please sign in to comment.