Introduction

Welcome to the generated API reference.

Do you use Postman? Great.
Get Postman Collection
Get Postman Environment

Header

Header	Value	When should I send?
Accept	application/json	All requests
Content-Type	application/x-www-form-urlencoded	Must send when passing query string in request body
Content-Type	application/json	Must send when passing json in request body
Content-Type	multipart/form-data	Must send when passing files in request body
Authorization	Bearer access_token	Whenever the resource requires an authenticated user
Language	language	All requests

Controlling requests

All API requests are limited to prevent abuse and ensure stability.
The limit is usually 120 requests every 1 minute. But each route can have its own limit.
You can always check the response header to have a status of available requests:

X-RateLimit-Limit → 120
X-RateLimit-Remaining → 25

Errors

API uses the following error codes:

Error Code	Meaning
400	Bad Request -- Your request sucks
401	Unauthorized -- Your API key is wrong
403	Forbidden -- You are not authorized or do not have permission to access
404	Not Found -- The specified page can not be found
405	Method Not Allowed -- Method not allowed for this request
406	Not Acceptable -- You have requested a format that is not valid
410	Gone -- The target resource is no longer available
413	Payload Too Large -- Request payload is larger than the server is willing or able to process
422	Unprocessable Entity -- Validation error, the given data was invalid
429	Too Many Requests -- You have sent too many requests in a certain amount of time ("rate limiting")
500	Internal Server Error -- We had a problem with our server. Try again later.
503	Service Unavailable -- We're temporarially offline for maintanance. Please try again later.

Authentication

Login

5 login attempts can be performed every 1 minute.

Example request:

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/customer/auth/login",
    "headers": {
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "email": "suelen.lozano@example.com",
        "password": "zFU41cAilq",
        "token_name": "My Computer"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

{
    "token_type": "Bearer",
    "access_token": "eyJ0eXAiOiJ..."
}

HTTP Request

POST api/v1/customer/auth/login

No authentication required

Parameters

Parameter	Type	Validation	Description
email	string	required|email
password	string	required|string|min:6
token_name	string	required|string|max:191	Client app name

Password recovery

Send password reset link do user

Example request:

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/customer/auth/password/recovery",
    "headers": {
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "email": "tatiane.cervantes@example.org"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

{
    "message": "Success message"
}

HTTP Request

POST api/v1/customer/auth/password/recovery

No authentication required

Parameters

Parameter	Type	Validation	Description
email	string	required|email

Reset the given user's password.

Example request:

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/customer/auth/password/reset",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/customer/auth/password/reset

Logout

Example request:

const axios = require('axios');

axios({
    "method": "delete",
    "url": "http://147.182.218.201:8447/api/v1/customer/auth/logout",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

DELETE api/v1/customer/auth/logout

Get the authenticated user

Example request:

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/customer/auth/user",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

null

HTTP Request

GET api/v1/customer/auth/user

Get all tokens

Example request:

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/customer/auth/tokens",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

null

HTTP Request

GET api/v1/customer/auth/tokens

Delete token

Example request:

const axios = require('axios');

axios({
    "method": "delete",
    "url": "http://147.182.218.201:8447/api/v1/customer/auth/tokens/{tokenId}",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

DELETE api/v1/customer/auth/tokens/{tokenId}

Change password

Example request:

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/customer/auth/change-password",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "password": "my_current_password",
        "password_new": "my_new_password",
        "password_new_confirmation": "my_new_password"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/customer/auth/change-password

Parameters

Parameter	Type	Validation	Description
password	string	required|string|min:6	Current password
password_new	string	required|string|min:6	New password
password_new_confirmation	string	required|string|min:6	Confirmation, must equal password_new

Change avatar

Example request:

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/customer/auth/change-avatar",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "multipart/form-data",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "avatar": "{file}"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

{
    "file_url": "{url}"
}

HTTP Request

POST api/v1/customer/auth/change-avatar

Parameters

Parameter	Type	Validation	Description
avatar	file	required|mimes:jpeg,png|max:4mb

Update lider de equipe

Example request:

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/customer/auth/update",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "multipart/form-data",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "avatar": "{file}",
        "name": "Dr. Fernando Duarte Cola\u00e7o Neto",
        "documento": "Non ab omnis sed ducimus necessitatibus.",
        "phone": "Quam aut voluptatem omnis.",
        "city_id": "ba28b9c3-9fe7-367f-b90e-a9cf377b9aa7",
        "email": "cleber01@example.net",
        "zipcode": "Nemo sapiente perspiciatis laboriosam vel iusto.",
        "street": "Esse quae voluptas labore veniam omnis.",
        "number": "Illo quidem in ea ut accusamus sequi hic.",
        "complement": "Molestiae aperiam quam ex molestiae iusto ut.",
        "district": "Omnis eaque dolorem sunt qui rem nesciunt quia.",
        "is_active": "1"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/customer/auth/update

Parameters

Parameter	Type	Validation	Description
avatar	file	nullable|mimes:jpeg,jpg,png|max:7mb
name	string	nullable|string|max:50
documento	string	nullable|string|max:20
phone	string	nullable|string|max:15
city_id	string	uuid	City relationship
email	string	sometime|nullable|string|email|max:100
zipcode	string	sometime|nullable|string|max:191
street	string	sometime|nullable|string|max:191
number	string	sometime|nullable|string|max:191
complement	string	sometime|nullable|string|max:191
district	string	sometime|nullable|string|max:191
is_active	boolean	boolean

Delete account

Example request:

const axios = require('axios');

axios({
    "method": "delete",
    "url": "http://147.182.218.201:8447/api/v1/customer/auth/delete-account",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

DELETE api/v1/customer/auth/delete-account

Diario

Get cronograma

Example request:

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/customer/diario/cronograma/{obra}",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

null

HTTP Request

GET api/v1/customer/diario/cronograma/{obra}

Get estatistica

Example request:

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/customer/diario/estatistica/{obra}",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

null

HTTP Request

GET api/v1/customer/diario/estatistica/{obra}

Get all diarios

Example request:

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/customer/diario/obra/{obra}",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

null

HTTP Request

GET api/v1/customer/diario/obra/{obra}

Query Parameters

Parameter	Type	Validation	Description
limit	integer	integer	Default: 20 Max: 100
page	integer	integer
orderBy	string	string	Default: id:asc. Available fields: id nome is_active created_at
search	string	string	Search in the fields: nome logradouro
day[0]	string	string	ISO 8601 Y-m-d Initial date
day[1]	string	string	ISO 8601 Y-m-d Final date
created_at[0]	string	string	ISO 8601 Y-m-d\TH:i:sP Initial date
created_at[1]	string	string	ISO 8601 Y-m-d\TH:i:sP Final date

Get diario

Example request:

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/customer/diario/{diario}",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

null

HTTP Request

GET api/v1/customer/diario/{diario}

Get etapas

Example request:

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/customer/diario/etapas/{diario}",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

null

HTTP Request

GET api/v1/customer/diario/etapas/{diario}

Create profissional

Example request:

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/customer/diario/create-profissional",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "name": "Dr. Jo\u00e3o Wellington Chaves Sobrinho",
        "cidade": "1b4bc3ce-1335-38ee-a703-24758a593bef",
        "documento": "Ratione sunt enim enim et est harum.",
        "email": "sabrina.dacruz@example.net",
        "phone": "Est tempora numquam in repudiandae eum velit quos.",
        "zipcode": "Labore saepe ex et blanditiis ipsam fugiat voluptatem.",
        "street": "Dicta natus neque sint numquam id ullam repudiandae voluptas.",
        "number": "Atque dignissimos pariatur eius perspiciatis nostrum vel.",
        "complement": "Maxime reprehenderit eos sint quis.",
        "district": "Doloribus enim aut voluptates harum sint."
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/customer/diario/create-profissional

Parameters

Parameter	Type	Validation	Description
name	string	required|string|max:50
cidade	string	nullable|string|max:191
documento	string	required|string|max:191
email	string	required|string|email|max:100
phone	string	nullable|string|max:191
zipcode	string	nullable|string|max:191
street	string	nullable|string|max:191
number	string	nullable|string|max:191
complement	string	nullable|string|max:191
district	string	nullable|string|max:191

Create diario

Example request:

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/customer/diario/create",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "multipart/form-data",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "obra_id": "399d41a3-5b98-38e9-8bd1-f46e0ab4a65e",
        "day": "2024-07-29T00:00:00-03:00",
        "profissionais[]": "68524d59-9817-352a-986c-08abf7ec512e",
        "presenca[]": "1",
        "motivo[]": "Quia iure occaecati ut repudiandae reiciendis.",
        "condicao_manha": "Sol",
        "condicao_tarde": "Nublado",
        "prejudicou_obra": "0",
        "obra_parada_cliente": "1",
        "etapas_pecas[]": "Quis odit officiis et vel odit.",
        "pecas[][]": "43c155b2-9404-3c5b-884c-39b8a1eb0ade",
        "montadas[][]": 8,
        "descarregadas[][]": 8,
        "defeituosas[][]": 7,
        "equipamentos[]": "44a477db-af42-3347-8a7b-bd799d14833d",
        "equip_alugado[]": "Quidem esse qui ex iure debitis dignissimos eos.",
        "data_inicio[]": "2024-07-29T09:00:00-03:00",
        "data_fim[]": "2024-07-29T18:00:00-03:00",
        "ocorrencia": "Reiciendis sapiente architecto quidem incidunt sequi.",
        "midias_ocorrencia[]": "{file}",
        "etapas[]": "Repellendus aperiam aspernatur odio rerum.",
        "categoria": "Earum culpa molestiae ut adipisci optio sapiente qui.",
        "atividade": "Nulla et dolor esse illum dicta voluptate ipsam quis.",
        "hora_inicio": "2019-07-29T00:00:00-03:00",
        "hora_fim": "2019-07-29T00:00:00-03:00",
        "status": "Conclu\u00eddo",
        "midias_atividadecomplementar[]": "{file}"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/customer/diario/create

Parameters

Parameter	Type	Validation	Description
obra_id	string	required|string	static(2) Obra relationship
day	string	string	ISO 8601 Y-m-d\TH:i:sP Initial date
profissionais[]	array	required|array	Array de uuid de profissionais
presenca[]	array	required|array	Array de booleano (0,1), se foi presente ou ausente, mesma ordem do array de profissionais
motivo[]	array	nullable|array	Array de string (max: 191 caracteres), se foi ausente o motivo, mesma ordem do array de profissionais
condicao_manha	string	required|string	Available values: Sol Chuva Nublado
condicao_tarde	string	required|string	Available values: Sol Chuva Nublado
prejudicou_obra	boolean	required|boolean	Default true
obra_parada_cliente	boolean	required|boolean	Default true
etapas_pecas[]	array	required|array	Array de id de etapas
pecas[][]	array	required|array	Array de arrays de uuid de pecas
montadas[][]	array	required|array	static(1) Array de arrays de quantidade
descarregadas[][]	array	required|array	static(1) Array de quantidade
defeituosas[][]	array	required|array	static(1) Array de quantidade
equipamentos[]	array	nullable|array	Array de uuid de equipamentos
equip_alugado[]	array	nullable|array	nome de equipamentos alugados
data_inicio[]	array	nullable|array	ISO 8601 Y-m-d\TH:i:sP data de inicio do equipamento alugado
data_fim[]	array	nullable|array	ISO 8601 Y-m-d\TH:i:sP data de fim do equipamento alugado
ocorrencia	string	nullable|max:191	texto sobre o ocorrido na obra, com insercao de midias
midias_ocorrencia[]	file	nullable|mimes:jpg,jpeg,png,mp4,avi,mov,webm,mpg,ogg,mkv,flv|max:4mb	midias sobre o ocorrido
etapas[]	array	nullable|array	Array de id de etapas
categoria	string	nullable|string
atividade	string	nullable|string
hora_inicio	string	nullable|string	ISO 8601 Y-m-d\TH:i:sP
hora_fim	string	nullable|string	ISO 8601 Y-m-d\TH:i:sP
status	string	nullable|string	Available values: Concluído Andamento Encerrado
midias_atividadecomplementar[]	file	nullable|mimes:jpg,jpeg,png,mp4,avi,mov,webm,mpg,ogg,mkv,flv|max:4mb	midias sobre a atividade complementar

Equipamentos

Get all equipamentos

Example request:

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/customer/equipamentos",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

null

HTTP Request

GET api/v1/customer/equipamentos

Query Parameters

Parameter	Type	Validation	Description
limit	integer	integer	Default: 20 Max: 100
page	integer	integer
orderBy	string	string	Default: id:asc. Available fields: id nome is_active created_at
search	string	string	Search in the fields: nome logradouro
created_at[0]	string	string	ISO 8601 Y-m-d\TH:i:sP Initial date
created_at[1]	string	string	ISO 8601 Y-m-d\TH:i:sP Final date

Faq

Get all faq

Example request:

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/customer/faq",
    "headers": {
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

null

HTTP Request

GET api/v1/customer/faq

No authentication required

Query Parameters

Parameter	Type	Validation	Description
limit	integer	integer	Default: 20 Max: 100
page	integer	integer
orderBy	string	string	Default: id:asc. Available fields: id name order created_at updated_at
search	string	string	Search in the fields: uuid name

Get faq

Example request:

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/customer/faq/{faq}",
    "headers": {
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

null

HTTP Request

GET api/v1/customer/faq/{faq}

No authentication required

How It Works

Get all how it works

Example request:

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/customer/how-it-works",
    "headers": {
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

null

HTTP Request

GET api/v1/customer/how-it-works

No authentication required

Permission required

how-it-works.list

Query Parameters

Parameter	Type	Validation	Description
limit	integer	integer	Default: 20 Max: 100
page	integer	integer
orderBy	string	string	Default: id:asc. Available fields: id name order created_at updated_at
search	string	string	Search in the fields: uuid name

Get how it works

Example request:

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/customer/how-it-works/{how_it_works}",
    "headers": {
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

null

HTTP Request

GET api/v1/customer/how-it-works/{how_it_works}

No authentication required

Permission required

how-it-works.show

Institutional

About app

Example request:

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/customer/institutional/about-app",
    "headers": {
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

null

HTTP Request

GET api/v1/customer/institutional/about-app

No authentication required

About company

Example request:

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/customer/institutional/company-app",
    "headers": {
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

null

HTTP Request

GET api/v1/customer/institutional/company-app

No authentication required

Privacy policy

Example request:

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/customer/institutional/privacy-policy",
    "headers": {
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

null

HTTP Request

GET api/v1/customer/institutional/privacy-policy

No authentication required

Terms of use

Example request:

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/customer/institutional/terms-of-use",
    "headers": {
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

null

HTTP Request

GET api/v1/customer/institutional/terms-of-use

No authentication required

Obra

Get all obras do usuario logado

Example request:

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/customer/obra",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

null

HTTP Request

GET api/v1/customer/obra

Query Parameters

Parameter	Type	Validation	Description
limit	integer	integer	Default: 20 Max: 100
page	integer	integer
orderBy	string	string	Default: id:asc. Available fields: id nome is_active created_at
search	string	string	Search in the fields: nome logradouro
status[0]	string	string	Array de status: Para iniciar,Andamento,Entregue,Parado,Na fila,Pausada
created_at[0]	string	string	ISO 8601 Y-m-d\TH:i:sP Initial date
created_at[1]	string	string	ISO 8601 Y-m-d\TH:i:sP Final date

Get Etapas da obra

Example request:

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/customer/obra/etapas/{obra}",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

null

HTTP Request

GET api/v1/customer/obra/etapas/{obra}

Permission required

obra.show

Get obra

Example request:

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/customer/obra/{obra}",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

null

HTTP Request

GET api/v1/customer/obra/{obra}

Permission required

obra.show

OnBoarding

Get all onboardings

Example request:

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/customer/onboarding",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

null

HTTP Request

GET api/v1/customer/onboarding

Query Parameters

Parameter	Type	Validation	Description
limit	integer	integer	Default: 20 Max: 100
page	integer	integer
orderBy	string	string	Default: id:asc. Available fields: id frase frase2 created_at
search	string	string	Search in the fields: frase frase2

Pecas

Get all peças

Example request:

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/customer/pecas/{categoriapeca}",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

null

HTTP Request

GET api/v1/customer/pecas/{categoriapeca}

Permission required

peca.list

Query Parameters

Parameter	Type	Validation	Description
limit	integer	integer	Default: 20 Max: 100
page	integer	integer
orderBy	string	string	Default: id:asc. Available fields: id nome codigo created_at
search	string	string	Search in the fields: nome codigo
created_at[0]	string	string	ISO 8601 Y-m-d\TH:i:sP Initial date
created_at[1]	string	string	ISO 8601 Y-m-d\TH:i:sP Final date

Profissionais

Get all profissionais

Example request:

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/customer/profissionais",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

null

HTTP Request

GET api/v1/customer/profissionais

Query Parameters

Parameter	Type	Validation	Description
limit	integer	integer	Default: 20 Max: 100
page	integer	integer
orderBy	string	string	Default: id:asc. Available fields: id nome is_active created_at
search	string	string	Search in the fields: nome logradouro
created_at[0]	string	string	ISO 8601 Y-m-d\TH:i:sP Initial date
created_at[1]	string	string	ISO 8601 Y-m-d\TH:i:sP Final date

Settings General

Get settings

Example request:

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/customer/settings/general",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

null

HTTP Request

GET api/v1/customer/settings/general

Permission required

settings-general.list

Webservice

Cities

Search city, must enter at least one of the search fields search or state_abbr
List a maximum of 50 items.

Example request:

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/customer/webservice/cities",
    "headers": {
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

null

HTTP Request

GET api/v1/customer/webservice/cities

No authentication required

Query Parameters

Parameter	Type	Validation	Description
search	string	string	Search in the fields: full_name
state_abbr	string	string

States

Example request:

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/customer/webservice/states",
    "headers": {
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

null

HTTP Request

GET api/v1/customer/webservice/states

No authentication required

Query Parameters

Parameter	Type	Validation	Description
search	string	string	Search in the fields: name

Find zipcode

Example request:

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/customer/webservice/zipcode/{zipcode}",
    "headers": {
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

Example response:

null

HTTP Request

GET api/v1/customer/webservice/zipcode/{zipcode}

No authentication required