API Overview:
Here you can find the basics of interacting with Rheem APIs.
Through Rheem APIs your application can retrieve the required data. Our API is organized around REST and designed to use resource oriented URLs and HTTP response codes to indicate API errors.
AUTHENTICATION:
Authentication is handled via an access token included in the Authorization header of each request. Please subscribe and call the Authentication API to retrieve your access token. You would need Oauth2.0 credentials to call the Token API.
Authorization: Bearer <YOUR_ACCESS_TOKEN>
API requests without authentication will fail.
HOW TO GET STARTED:
Sign up and get your login details via email. Sign in and click on products to view all the Products. Enter the Product name you want to use and hit the subscribe button. Once your subscription is active, you will be able to see the subscription details including subscription key in Profile and you will be provided with Client ID, Secret and scope. Pass the Client ID, Secret and scope in the Authentication API header to get the access token. Pass the token in Authorization header and subscription key in Ocp-Apim-Subscription-Key header in all other APIs to get the response.
Sample request:
POST /v1/estimates HTTP/1.1
Content-Type: application/json
Authorization: Bearer <YOUR_ACCESS_TOKEN>
{
"items" : [
{
"orderID" : 12345,
"orderedDate" : "2024-01-01T13:00:00Z",
"name" : "John Doe",
"email" : "JD@test.com",
"quantity" : 1,
"value" : 20
} ],
"pickup_location" :
{
"address" :
{
"street1" : "123 Main Street",
"city" : "Atlanta",
"state" : "GA",
"zip" : "30305"
} }, c
"delivery_location" :
{
"address" : { "street1" : "456 Central Ave.",
"city" : "Atlanta",
"state" : "GA",
"zip" : "30308"
} },
"pickup_after" : "2019-01-01T13:00:00Z",
"deliver_between" :
{
"start" : "2019-01-01T21:00:00Z",
"end": "2019-01-01T23:00:00Z"
}
}
Sample Response:
{
"orderstatus" : "delivered",
"itemsize" : "large",
"price": 1200
}
Status codes
200 OK – Successful
201- Created
202- Accepted
400 Bad Request – client sent an invalid request, such as lacking required request body or parameter
401 Unauthorized – access denied due to invalid subscription key.
403 Forbidden – client authenticated but does not have permission to access the requested resource
404 Not Found – the requested resource was not found on the server
500 Internal Server Error – the server encountered an error while processing the request