Explore

BlueRoof APIs

Shashank Jain

Live Base URL :

https://app.hcsblueroof.com/⁠

⁠

Test Base URL :

https://blueroof.bytequests.com⁠

Login API:

Request URL:

api/admin/login

Request Type :

POST

Request Headers :

Content-Type : application/json

Request payload:

{

"email": "test@test.com",

"password": "pass@123"

}

Sample Error Response

{

"error": true,

"message": "Credentials do not match"

}

Sample Success Response

{

"error": false,

"message": "You're Logged in!",

"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI3IiwianRpIjoiNGYzNTgyMWE2NzFhNmE4ZWM2OGQ0OTAyNmZhOGYzOGJiMWViOTcxMWIxMmRjODEzNWU0MmFhOTRkOGU5OTdlMjJmY2Y2NzVmNjc2NmUzODkiLCJpYXQiOjE2MjcyMDI3MjgsIm5iZiI6MTYyNzIwMjcyOCwiZXhwIjoxNjU4NzM4NzI4LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.QRkkm_JV7nCL0ZWFegmdtecSr7i36di71GlRjA8rhAAJBjzbOmTldgY3qFVavrQGOcobFS2KXbkD-pwmWn5BjjkRqxK6pZ-9uTytTQ1wmZI8qJIhyGyrOI1KYv5cm1appvegaLw5A7wlDaYHnlWEoGkum-vPgQkvTbVO_O7UOAT7zyKIQNTidxzDFpXfWCgIfZVVPN8_HkBMXE-uAGUVE1EjMNgZbLt9KF_gen7y-1vrfPYuiESCYmnbzFHnAbi9dODUAjgJsu98xrYr_JMWzbT-csStQtMMfWbf-iQEbHsiQ_G9FV9UdF3v1ow_Z-ud1eBLbZxUM9hc3MW3P_7InUp5ecn0La2hU1LOn-_mkdCeK199_LHSfq33xMXVff2kP1ryvAZYi6-VSLedUdK9FTr84V3vKT0UIakStg36NSQetb3y40KHqcAxCjHgkdkOZfBxo4rlk_Cyrp7BumkH9KK3JHO3Wfc08MLTPrXwGdr4Z5cHTPrKuq0AmsUd6d90wVy4vIwyS1lhIjk_IPXjvv8WBAtgg3k-IlYFUKep_Kb6NpmABubvcf0PhzPr4HJNvTaYzRNbpwv4SE77k7H_E1JTnQHL28OwyRZlaAavXExdTPQvnd8IHq8kEvc0lVS-yY7Ai92Aa3Pj0VrDPhA8Out_avgerx7_dCbxLx_tOuQ"

}

This token is used in all subsequent requests as Auth Header

Logs API

Request URL

api/logs

Request Type :

POST

Request Headers :

Content-Type : application/json

Authorization : Bearer {{token value from login api}}

Request payload:

{

"start": "2020-01-01",

"end": "2021-07-01"

}

Sample Error Response

{

"error": true,

"message": "Credentials do not match"

}

Sample Success Response

{

"error": false,

"message": "File SuccessFul",

"file": "export/logs-2020-01-01-to-2021-07-01.csv"

}

The log file full url is : BASE_URL + {{file value from response}}

i.e:

https://blueroof.bytequests.com/export/logs-2020-01-01-to-2021-07-01.csv⁠

⁠

Want to print your doc?
This is not the way.

Try clicking the ⋯ next to your doc name or using a keyboard shortcut (

CtrlP

) instead.