Access Red Rover data via this REST API for Organizations that have granted you access. # Authentication The API is protected by HTTP Basic Authentication. Each application that connects to the API has a unique username and password that it must supply with every request. This value needs to be supplied as an HTTP Header: `Authorization=BASIC [hash]`. The value of [hash] is the string username:password base64 encoded. Endpoints marked for Basic Auth can be used with the Basic Auth username and password that you have been assigned. # API Information ## Api Key Each Red Rover organization that has authorized your application has a unique API Key for your application. To retrieve the API Key, you can use the Organization endpoint (`api/v1/organization`) which returns an ApiKey uniquely used for each Organization. You must supply this as an HTTP Header when accessing that organization: `apiKey=[apiKey]`. The domains that require this `ApiKey` header are labeled as 'Requires an ApiKey'. ## Identifier Where an `Identifier` can be specified in the route, you may either supply the Red Rover Id of the object (numeric) or the External Id (alpha-numeric). When specifying an External Id, you will need to prepend the External Id with the pike character`|` (e.g. `|ABC123`). # noqa: E501
Metadata
Release files for redrover-api 1.6.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| redrover-api-1.6.1.tar.gz | 112.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| redrover_api-1.6.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 457.9 kB
Release files / redrover-api-1.6.1.tar.gz
| Download URL | redrover-api-1.6.1.tar.gz |
|---|---|
| Size | 112.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4d748a1a47b17f9f8a5d71766c164e642f72a16f8a33b29e251f58c9ac1c2e6b
|
|
BLAKE2b-256 checksum How to use checksums |
f3d0ce682b82b1fbc7e2db498f4efe93841f3b4d1a5741a17084828b885ee2bb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.1 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.8.10
|
Release files / redrover_api-1.6.1-py3-none-any.whl
| Download URL | redrover_api-1.6.1-py3-none-any.whl |
|---|---|
| Size | 345.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
62a5ed3a04f169c0721a5fe3f871f967c2de6e003738c489dce85c0ef9a9ea06
|
|
BLAKE2b-256 checksum How to use checksums |
fb2feb49cf66b69bcc4abdab4f1a0230bc8ac9f8ecf064346b19f3327ad8b3ad
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.1 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.8.10
|