This release is a pre-release and may not be stable for production use.
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
1 maintainer
Metadata
1 maintainer
Release files for redrover-api 1.9.1.dev0
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.9.1.dev0.tar.gz | 802.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| redrover_api-1.9.1.dev0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.6 MB
Release files / redrover-api-1.9.1.dev0.tar.gz
| Download URL | redrover-api-1.9.1.dev0.tar.gz |
|---|---|
| Size | 802.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a9e48c4d15d6e54e0ae98b469677f693d8e6e31759a0b540e09adf002fe5e472
|
|
BLAKE2b-256 checksum How to use checksums |
ff046d54e7393a0c79f0166bf7a7898ac017769f7ee8553319b210e20b1cac31
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.7
|
Release files / redrover_api-1.9.1.dev0-py3-none-any.whl
| Download URL | redrover_api-1.9.1.dev0-py3-none-any.whl |
|---|---|
| Size | 785.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
142e775dceee1a1859c04e2496bc17b80df7c9f93eaf52839511fa39245495dd
|
|
BLAKE2b-256 checksum How to use checksums |
1f63f26b33f9b10e3b80999bfc48f5dbeede4f2b7f9d90e0cf9edae5dfff8520
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.7
|
