Red Rover API
Project description
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
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
Built Distribution
Hashes for redrover_api-1.6.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 62a5ed3a04f169c0721a5fe3f871f967c2de6e003738c489dce85c0ef9a9ea06 |
|
MD5 | 471d91667c2e661af3778ccb501df218 |
|
BLAKE2b-256 | fb2feb49cf66b69bcc4abdab4f1a0230bc8ac9f8ecf064346b19f3327ad8b3ad |