Welcome to Tidybear API
Basics
The Tidybear API is built with the REST architecture. The HTTP codes are useful to understand the server response.
- 201 : The resource is created, you can access the resource through the URI in the Location HTTP header
- 204 : The request has been processed but there is nothing to return
- 400 : The parameters are incorrect
- 401 : Unable to authenticate, the login or password is incorrect
- 403 : You are authenticated but you have not enough rights to access the resource
- 404 : Resource not found
- 405 : The HTTP method used is not available for this resource
- 500 : An unexpected error occurs
All the resources consume and produce JSON format.
Some query parameters of the API can contains several values. In this documentation the parameter type is set to String[]. To do so, add this parameter several times
https://api.url?param=1¶m=2
Tidybear provides two environments.
DEV environment
DEV environment for testing purpose
API root : https://apidev.tidybear.fr/tidybear/583d8b5c07d27eb744a0003c
PROD environment
PROD environment for production
API root : https://api.tidybear.fr/tidybear
Security
Tidybear API is reachable through HTTPS, the datas are encrypted. Two authentication systems are available. Tidybear API supports HTTP Basic Authentication and provides an Authentication Token the first time the user authenticates.
HTTP Basic Authentication
The API waits the credentials through the Authorization HTTP header. To build a Basic HTTP Authentication, you need to encode login:password with Base64 and add the keyword 'Basic' at the beginning.
Example :
login = "tidylogin"
password = "mytidypassword"
authentication = "Basic "+encodeBase64(login+":"+password) // Basic dGlkeWxvZ2luOm15dGlkeXBhc3N3b3Jk
Authentication Token
Once you authenticated with the Basic HTTP Authentication, the API provides an Authentication Token instead of sending your credentials on the network every time you make a request.
You receive the Authentication Token in the Authorization HTTP header in the HTTP response. The token expires 7 days after it has been built. You just need to paste it in the Authorization HTTP Header for the next requests.
Example :
Custom eyJ0aW1lc3RhbXAiOiIxUW9WcE54YXo2L3N6d2tEN21QZ0l5UnM9In0=
Resources
/utilities
Utilities is a useful resource to get some tools as price estimate, hours of work estimate, etc. Learn more