Skip to main content

Stencila Hub API

Project description

## Authentication Many endpoints in the Stencila Hub API require an authentication token. These tokens carry many privileges, so be sure to keep them secure. Do not place your tokens in publicly accessible areas such as client-side code. The API is only served over HTTPS to avoid exposing tokens and other data on the network. To obtain a token, [`POST /api/tokens`](#operations-tokens-tokens_create) with either a `username` and `password` pair, or an [OpenID Connect](https://openid.net/connect/) token. Then use the token in the `Authorization` header of subsequent requests with the prefix `Token` e.g. curl -H "Authorization: Token 48866b1e38a2e9db0baada2140b2327937f4a3636dd5f2dfd8c212341c88d34" https://hub.stenci.la/api/projects/ Alternatively, you can use `Basic` authentication with the token used as the username and no password. This can be more convenient when using command line tools such as [cURL](https://curl.haxx.se/) e.g. curl -u 48866b1e38a2e9db0baada2140b2327937f4a3636dd5f2dfd8c212341c88d34: https://hub.stenci.la/api/projects/ Or, the less ubiquitous, but more accessible [httpie](https://httpie.org/): http –auth 48866b1e38a2e9db0baada2140b2327937f4a3636dd5f2dfd8c212341c88d34: https://hub.stenci.la/api/projects/ In both examples above, the trailing colon is not required but avoids being asked for a password. ## Versioning The Stencila Hub is released using semantic versioning. The current version is available from the [`GET /api/status`](/api/status) endpoint. Please see the [Github release page](https://github.com/stencila/hub/releases) and the [changelog](https://github.com/stencila/hub/blob/master/CHANGELOG.md) for details on each release. We currently do not provide versioning of the API but plan to do so soon (probably by using a `Accept: application/vnd.stencila.hub+json;version=1.0` request header). If you are using, or interested in using, the API please contact us and we may be able to expedite this. # noqa: E501

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

stencila.hub-4.47.19.tar.gz (108.1 kB view details)

Uploaded Source

Built Distribution

stencila.hub-4.47.19-py3-none-any.whl (366.2 kB view details)

Uploaded Python 3

File details

Details for the file stencila.hub-4.47.19.tar.gz.

File metadata

  • Download URL: stencila.hub-4.47.19.tar.gz
  • Upload date:
  • Size: 108.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.10

File hashes

Hashes for stencila.hub-4.47.19.tar.gz
Algorithm Hash digest
SHA256 a89738aa9d9dcdd1bf45e8ffe26bc0de602fe20fddfcb925e8803a9ac452ad20
MD5 e3543b9683a39c92b50ca498fd7501df
BLAKE2b-256 62f953dc679fed1edc528a92d753eeef198fc51c2068db22202447d68e8e1e50

See more details on using hashes here.

File details

Details for the file stencila.hub-4.47.19-py3-none-any.whl.

File metadata

  • Download URL: stencila.hub-4.47.19-py3-none-any.whl
  • Upload date:
  • Size: 366.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.10

File hashes

Hashes for stencila.hub-4.47.19-py3-none-any.whl
Algorithm Hash digest
SHA256 826165f77bfb60b2d94862c087148f35fc3e92bedc5e2dcec94da09def9765e8
MD5 c8dfb5b84a64fac0fbc11184533bca98
BLAKE2b-256 9f0085a7341ba2f808640b980ffe42e895687cd65fb69b01a2c5da405c3b8b0a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page