API DOCUMENTATION
Introduction
Our API’s functionalities are the following:
- The creation of a customer’s demands. If the customer does not exist, it will be added.
- The creation, modification and consultation of activities. You can consult all the activities by different criteria. You can also consult a specific activity by its identifier.
- The consultation of the customers, whether they are all the customers of the company or one customer from their identifier.
- The consultation of the company’s users.
- The consultation of a property from its identifier.
- The consultation of the company’s operations.
- Consultation of the company’s bookings.
- Consultation and creation of company matchings.
- Additional information can be found in resources, such as the following:
- Languages
- Types of activities
- Resolutions of activities
request examples
curl --location ‘$URL’ \
--header 'Accept: application/json' \
--header 'Authorization: Bearer SECRETOKEN'
Responses examples
200 OK:
{
“data”: {
"id_customer": “9a8sud@A=”,
…
}
}
The content of "data" will vary according to each call.
400:
“error”: {
{
"code": 400,
"description": "Bad Request",
"message": "The provided property id format is incorrect"
}
}
The message will vary depending on the error
.
401:
“error”: {
{
"code": 401,
"description": "Unauthenticated",
"message": "You are not authenticated"
}
}
404:
“error”: {
{
"code": 404,
"description": "Not found",
"message": "The provided activity id does not exist in our database"
}