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 pipe character`|` (e.g. `|ABC123`). Please note that this is only the case when the External Id is within the route. If the External Id is contained within the body of the request, do not append the pipe character. ## Transaction Id Each request can be supplied with a `TransactionId` GUID which will be logged with the request. The `Transaction Id` can be supplied as an HTTP Header: `TransactionId=[transactionId]`. If no `Transaction Id` is supplied, one will be generated for you. Please use a distinct TransactionId for each request.
Raw data
{
"_id": null,
"home_page": "https://github.com/edustaff/redrover-api",
"name": "redrover-api",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, Red Rover API",
"author": "Developer",
"author_email": "dev@redroverk12.com",
"download_url": "https://files.pythonhosted.org/packages/7c/05/86c6df8fabfda0f9baba60ed0999a1cdc722b2db58a9635b9ef9182259fc/redrover-api-1.13.0.tar.gz",
"platform": null,
"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 pipe character`|` (e.g. `|ABC123`). Please note that this is only the case when the External Id is within the route. If the External Id is contained within the body of the request, do not append the pipe character. ## Transaction Id Each request can be supplied with a `TransactionId` GUID which will be logged with the request. The `Transaction Id` can be supplied as an HTTP Header: `TransactionId=[transactionId]`. If no `Transaction Id` is supplied, one will be generated for you. Please use a distinct TransactionId for each request.\n \n",
"bugtrack_url": null,
"license": null,
"summary": "Red Rover API",
"version": "1.13.0",
"project_urls": {
"Homepage": "https://github.com/edustaff/redrover-api"
},
"split_keywords": [
"openapi",
" openapi-generator",
" red rover api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "41a97ef16eeaf6c494794f96aa577b7752c025d5a6494c673be149fae1cc7d1d",
"md5": "37089ce1686992f2b16b2fb7c4971bfe",
"sha256": "adb81d6eb7cde539569f15fad6eda84729d487bfcff73bdccec3dc65917acc8a"
},
"downloads": -1,
"filename": "redrover_api-1.13.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "37089ce1686992f2b16b2fb7c4971bfe",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 314281,
"upload_time": "2024-06-26T13:37:28",
"upload_time_iso_8601": "2024-06-26T13:37:28.887121Z",
"url": "https://files.pythonhosted.org/packages/41/a9/7ef16eeaf6c494794f96aa577b7752c025d5a6494c673be149fae1cc7d1d/redrover_api-1.13.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7c0586c6df8fabfda0f9baba60ed0999a1cdc722b2db58a9635b9ef9182259fc",
"md5": "bbe8d972437201b4e54f0f3e483ce7a0",
"sha256": "65faca351c3dc31e1f3a8c57346e0f7b43ef3c46c711272d94b8f442bf1518a5"
},
"downloads": -1,
"filename": "redrover-api-1.13.0.tar.gz",
"has_sig": false,
"md5_digest": "bbe8d972437201b4e54f0f3e483ce7a0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 179375,
"upload_time": "2024-06-26T13:37:30",
"upload_time_iso_8601": "2024-06-26T13:37:30.814032Z",
"url": "https://files.pythonhosted.org/packages/7c/05/86c6df8fabfda0f9baba60ed0999a1cdc722b2db58a9635b9ef9182259fc/redrover-api-1.13.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-26 13:37:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "edustaff",
"github_project": "redrover-api",
"github_not_found": true,
"lcname": "redrover-api"
}
JSON
