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.

About app

Get about app

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/about-app",
    "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
});

null

HTTP Request

GET api/v1/admin/about-app

Permission required

about-app.edit

Update about app

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/about-app",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "name": "Sint nihil culpa quia qui.",
        "text": "Aut tempora sint iure autem ipsa maiores ut. Vitae accusantium totam voluptas nobis. Magni laboriosam omnis nisi veritatis."
}
})
.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/admin/about-app

Permission required

about-app.edit

Parameters

Parameter	Type	Validation	Description
name	string	string\|max:191
text	string	nullable\|string\|max:60000	HTML allowed

About company

Get about company

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/company-app",
    "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
});

null

HTTP Request

GET api/v1/admin/company-app

Permission required

about-company.edit

Update about company

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/company-app",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "name": "Laboriosam non ea eligendi et distinctio qui.",
        "text": "Magni distinctio soluta rem reprehenderit. Et voluptate velit magnam eum. Qui laborum est cupiditate accusantium vitae. Sapiente odio ipsum cum. Sit delectus natus totam fugit."
}
})
.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/admin/company-app

Permission required

about-company.edit

Parameters

Parameter	Type	Validation	Description
name	string	string\|max:191
text	string	nullable\|string\|max:60000	HTML allowed

Authentication

Login

5 login attempts can be performed every 1 minute.

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/auth/login",
    "headers": {
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "email": "lidiane97@example.net",
        "password": "RubM2ACymD",
        "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
});

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

HTTP Request

POST api/v1/admin/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

const axios = require('axios');

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

{
    "message": "Success message"
}

HTTP Request

POST api/v1/admin/auth/password/recovery

No authentication required

Parameters

Parameter	Type	Validation	Description
email	string	required\|email

Reset the given user's password.

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/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/admin/auth/password/reset

Logout

const axios = require('axios');

axios({
    "method": "delete",
    "url": "http://147.182.218.201:8447/api/v1/admin/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/admin/auth/logout

Get the authenticated user

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/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
});

null

HTTP Request

GET api/v1/admin/auth/user

Get all tokens

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/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
});

null

HTTP Request

GET api/v1/admin/auth/tokens

Delete token

const axios = require('axios');

axios({
    "method": "delete",
    "url": "http://147.182.218.201:8447/api/v1/admin/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/admin/auth/tokens/{tokenId}

Change password

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/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/admin/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

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/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
});

{
    "file_url": "{url}"
}

HTTP Request

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

Parameters

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

Categoria de pecas

Get all categoria de peças

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/categoria-pecas",
    "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
});

null

HTTP Request

GET api/v1/admin/categoria-pecas

Permission required

categoriapeca.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

Create Peça

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/categoria-pecas",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "nome": "Praesentium id aut cumque eligendi.",
        "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/admin/categoria-pecas

Permission required

categoriapeca.create

Parameters

Parameter	Type	Validation	Description
nome	string	required\|string\|max:191
is_active	boolean	boolean	Default true

Export peças

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/categoria-pecas/export",
    "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
});

{
    "file_url": "{url}"
}

HTTP Request

GET api/v1/admin/categoria-pecas/export

Permission required

categoriapeca.export

Query Parameters

Parameter	Type	Validation	Description
orderBy	string	string	Default: `id:asc`. Available fields: `id` `nome` `codigo`
search	string	string	Search in the fields: `uuid` `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

Get Peça

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/categoria-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
});

null

HTTP Request

GET api/v1/admin/categoria-pecas/{categoriapeca}

Permission required

categoriapeca.show

Update peça

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/categoria-pecas/{categoriapeca}",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "nome": "Dolores iste aut veritatis sunt aperiam aut.",
        "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/admin/categoria-pecas/{categoriapeca}

Permission required

pecas.edit

Parameters

Parameter	Type	Validation	Description
nome	string	required\|string\|max:191
is_active	boolean	boolean	Default true

Remove peça

const axios = require('axios');

axios({
    "method": "delete",
    "url": "http://147.182.218.201:8447/api/v1/admin/categoria-pecas/{categoriapeca}",
    "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/admin/categoria-pecas/{categoriapeca}

Permission required

categoriapeca.delete

Dashboard

Get summary of data

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/dashboard",
    "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
});

null

HTTP Request

GET api/v1/admin/dashboard

Diario

Get all diarios

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/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
});

null

HTTP Request

GET api/v1/admin/diario

Permission required

diario.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` `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

Get diario

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/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
});

null

HTTP Request

GET api/v1/admin/diario/{diario}

Permission required

diario.show

Update diario

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/diario/{diario}",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "ocorrencia": "Est sed non perferendis laudantium.",
        "condicao_manha": "Qui aut perspiciatis incidunt pariatur nam.",
        "condicao_tarde": "Nesciunt et numquam placeat ex eum eveniet.",
        "prejudicou_obra": "0",
        "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/admin/diario/{diario}

Permission required

diario.edit

Parameters

Parameter	Type	Validation	Description
ocorrencia	string	string\|max:400
condicao_manha	string	string\|max:10
condicao_tarde	string	string\|max:10
prejudicou_obra	boolean	boolean	Default true
is_active	boolean	boolean	Default true

Remove diario

const axios = require('axios');

axios({
    "method": "delete",
    "url": "http://147.182.218.201:8447/api/v1/admin/diario/{diario}",
    "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/admin/diario/{diario}

Permission required

diario.delete

Equipamentos

Get all equipamentos

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/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
});

null

HTTP Request

GET api/v1/admin/equipamentos

Permission required

equipamentos.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` `marca` `modelo` `fabricante` `created_at`
search	string	string	Search in the fields: `nome` `codigo` `marca` `modelo` `fabricante`
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

Create Equipamento

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/equipamentos",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "nome": "Nobis quod ea nihil et voluptas veniam numquam.",
        "codigo": "Dolores et adipisci sit officiis quia.",
        "marca": "Ducimus fuga animi voluptates sunt deleniti.",
        "modelo": "Aut unde inventore optio dolorum qui eligendi optio.",
        "fabricante": "Incidunt officiis omnis sint quae et.",
        "quantidade": "1",
        "is_active": "0"
}
})
.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/admin/equipamentos

Permission required

equipamentos.create

Parameters

Parameter	Type	Validation	Description
nome	string	required\|string\|max:191
codigo	string	required\|string\|max:191
marca	string	required\|string\|max:191
modelo	string	required\|string\|max:191
fabricante	string	required\|string\|max:191
quantidade	required\|integer	integer
is_active	boolean	boolean	Default true

Export equipamentos

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/equipamentos/export",
    "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
});

{
    "file_url": "{url}"
}

HTTP Request

GET api/v1/admin/equipamentos/export

Permission required

equipamento.export

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` `marca` `modelo` `fabricante` `created_at`
search	string	string	Search in the fields: `nome` `codigo` `marca` `modelo` `fabricante`
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 Equipamento

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/equipamentos/{equipamento}",
    "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
});

null

HTTP Request

GET api/v1/admin/equipamentos/{equipamento}

Permission required

equipamentos.show

Update equipamento

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/equipamentos/{equipamento}",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "nome": "Sit libero sunt velit quo quae.",
        "codigo": "Expedita officiis iusto error dolore animi et id.",
        "marca": "Et reiciendis maxime perspiciatis quaerat expedita eos neque.",
        "modelo": "Natus adipisci tempore voluptas voluptatum.",
        "fabricante": "Dolor provident laborum et id vel consequatur cupiditate.",
        "quantidade": "1",
        "is_active": "0"
}
})
.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/admin/equipamentos/{equipamento}

Permission required

equipamentos.edit

Parameters

Parameter	Type	Validation	Description
nome	string	sometimes\|nullable\|string\|max:191
codigo	string	sometimes\|nullable\|string\|max:191
marca	string	sometimes\|nullable\|string\|max:191
modelo	string	sometimes\|nullable\|string\|max:191
fabricante	string	sometimes\|nullable\|string\|max:191
quantidade	sometimes\|nullable\|integer	integer
is_active	boolean	sometimes\|nullable\|boolean	Default true

Remove equipamento

const axios = require('axios');

axios({
    "method": "delete",
    "url": "http://147.182.218.201:8447/api/v1/admin/equipamentos/{equipamento}",
    "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/admin/equipamentos/{equipamento}

Permission required

equipamento.delete

Equipes

Get all Equipes

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/equipe",
    "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
});

null

HTTP Request

GET api/v1/admin/equipe

Permission required

equipe.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` `email` `avatar` `is_active` `created_at` `updated_at`
search	string	string	Search in the fields: `uuid` `name` `email`
obra	string	string
is_active	integer	integer	Available values: `0` `1`
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

Export Equipes

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/equipe/export",
    "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
});

{
    "file_url": "{url}"
}

HTTP Request

GET api/v1/admin/equipe/export

Permission required

equipe.export

Query Parameters

Parameter	Type	Validation	Description
orderBy	string	string	Default: `id:asc`. Available fields: `id` `name` `email` `avatar` `is_active` `created_at` `updated_at`
search	string	string	Search in the fields: `uuid` `name` `email`
is_active	integer	integer	Available values: `0` `1`
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

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/faq",
    "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
});

null

HTTP Request

GET api/v1/admin/faq

Permission required

faq.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` `is_active` `created_at` `updated_at`
search	string	string	Search in the fields: `uuid` `name`
is_active	integer	integer	Available values: `0` `1`
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

Create faq

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/faq",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "name": "Nisi quidem molestias quis culpa exercitationem quibusdam.",
        "text": "Quando as bonecas de Capit\u00fa iniciou um movimento inverso, relativamente \u00e1 minha, indo para um lado, quando eu a buscasse nem suspeitasse. Os silencios dos ultimos dias, que me embriagou, e a copa, atirou-se \u00e1s despezas superfluas, deu joias \u00e1 mulher, nos dias de festa matava um leit\u00e3o, era visto em theatros, chegou aos sapatos de cordav\u00e3o rasos e velhos, a que ella chorou muito; mas aqui est\u00e3o os retratos de ambos, sem que ousasse um pouco das reminiscencias osculares; mas a saudade \u00e9 isto mesmo; \u00e9 o mesmo; mas se conto aqui, taes quaes, os dous ultimos annos de edade, e podia voltar para Itaguahy. N\u00e3o quiz; preferiu ficar perto da praia, grandes passaros que as tomam nos bicos, de espa\u00e7o a espa\u00e7o. Nos quatro cantos do tecto as figuras da sala de visitas, se \u00e9 que sabe do todos. Comtudo, uma promessa assim... n\u00e3o sei... Creio que, bem pensado... Voc\u00ea que acha, prima Justina? --Eu? --Verdade \u00e9 que Deus o determine. N\u00e3o me chames dissimulado, chama-me compassivo; \u00e9 certo que receiava perder Capit\u00fa, se pudesse cumpril-o, n\u00e3o me disse ao ouvido, em voz alta: --Mas, Bentinho, que \u00f3 protonotario apostolico? --Ora, vivam! exclamou o pae. --Que susto, meu Deus! Agora \u00e9 que Deus o determine. N\u00e3o me tenhas por sacrilego, leitora minha devota; a limpeza da inten\u00e7\u00e3o lava o que era. Depois, ainda falou gravemente e longamente sobre a borda do po\u00e7o. Ventava, o ceu em n\u00f3s. As m\u00e3os, unindo os nervos, faziam das duas creaturas uma s\u00f3, mas uma s\u00f3 creatura seraphica. Os olhos fitavam-se e desfitavam-se, e depois de certa hesita\u00e7\u00e3o, disse-lhe que eram levemente grossas ou finas, conforme o sexo dos interlocutores, e reproduziam com modera\u00e7\u00e3o a ternura e a adula\u00e7\u00e3o. Oh! a adula\u00e7\u00e3o! D. Fortunata ralhava: --Jo\u00e3osinho, voc\u00ea \u00e9 crean\u00e7a? Mas, tanto lhe ouviu falar em morte que teve medo, e um annos de edade, e podia voltar para Itaguahy. N\u00e3o quiz; preferiu ficar perto da praia, grandes passaros que as palavras de uns e de longe, usava repetil-a nos nossos jogos da puericia, rindo, saltando.",
        "order": 3,
        "is_active": "0"
}
})
.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/admin/faq

Permission required

faq.create

Parameters

Parameter	Type	Validation	Description
name	string	required\|string\|max:191
text	string	nullable\|string\|max:10000
order	integer	required\|integer
is_active	boolean	boolean	Default true

Get additional information

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/faq/additional-information",
    "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
});

{
    "next_order": 5
}

HTTP Request

GET api/v1/admin/faq/additional-information

Export faq

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/faq/export",
    "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
});

{
    "file_url": "{url}"
}

HTTP Request

GET api/v1/admin/faq/export

Permission required

faq.export

Query Parameters

Parameter	Type	Validation	Description
orderBy	string	string	Default: `id:asc`. Available fields: `id` `name` `order` `is_active` `created_at` `updated_at`
search	string	string	Search in the fields: `uuid` `name` `email`
is_active	integer	integer	Available values: `0` `1`
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 faq

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/faq/{faq}",
    "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
});

null

HTTP Request

GET api/v1/admin/faq/{faq}

Permission required

faq.show

Update faq

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/faq/{faq}",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "name": "Temporibus aliquid ducimus dolor ea.",
        "text": "Maxime optio quia numquam quibusdam sint. Ex aperiam dolore nulla eum et ratione. Adipisci voluptas rerum ut dignissimos.",
        "order": 9,
        "is_active": "0"
}
})
.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/admin/faq/{faq}

Permission required

faq.edit

Parameters

Parameter	Type	Validation
name	string	string\|max:191
text	string	nullable\|string\|max:10000
order	integer	required\|integer
is_active	boolean	boolean

Remove faq

const axios = require('axios');

axios({
    "method": "delete",
    "url": "http://147.182.218.201:8447/api/v1/admin/faq/{faq}",
    "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/admin/faq/{faq}

Permission required

faq.delete

How It Works

Get all how it works

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/how-it-works",
    "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
});

null

HTTP Request

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

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` `is_active` `created_at` `updated_at`
search	string	string	Search in the fields: `uuid` `name`
is_active	integer	integer	Available values: `0` `1`
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

Create how it works

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/how-it-works",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "name": "Et quam voluptatem accusamus sunt.",
        "text": "N\u00e3o disse nada a meu pae, olhando para o seminario. Capit\u00fa n\u00e3o se lembra como \u00e9 que voc\u00ea j\u00e1 tinha vindo. A mentira espantou-me, n\u00e3o menos que outras que lhe chamassem o protonotario Cabral. --Mas, Sr. Jos\u00e9 Dias, depois de alguns instantes. --Pois que outra cousa que n\u00e3o podia deixar de cumprir. Fiquei t\u00e3o satisfeito de ver que assim confirmava a denuncia de Jos\u00e9 Dias. --Mas eu n\u00e3o ria daquella vez por estar ao p\u00e9 de mim, e, n\u00e3o querendo interrogal-a novamente, entrei a alisal-os com o passo vagaroso e rigido. Tambem se descompunha em accionados, era muita vez n\u00e3o passavam da simples repeti\u00e7\u00e3o do titulo. Estava em p\u00e9, dava alguns passos, sorria ou tamborilava na tampa da boceta. O tamanho do titulo como que fundidas, n\u00e3o podiam dizer tudo. --Sou homem! Quando repeti isto, pela terceira vez, pensei no seminario, tirei dous vintens do bolso e dei-os ao mendigo. Este beijou a moeda; eu pedi-lhe que rogasse a Deus por mim, afim de se consolar da tocha, da miseravel tocha. E comtudo havia outros que tambem traziam tocha, e apenas lhe respondeu com um enfadamento gracioso e voluntario que \u00e1s vezes por desaso, outras de menos, e perder um emprego interino? N\u00e3o, senhor, devia ser homem, pae de Capit\u00fa. Caso houve, por\u00e9m, no qual n\u00e3o sei se diga com amor. Um dia fui achal-a desenhando a lap\u00eds um retraio; dava os ultimos rasgos, e pediu-me que outra cousa quero eu, sen\u00e3o servil-o? Que desejo, sen\u00e3o que seja feliz, como merece? --Pois ainda \u00e9 tempo. Olhe, n\u00e3o \u00e9 bonito que o reitor de S. Jos\u00e9. Minha m\u00e3e assoou-se sem responder. Prima Justina creio que Capit\u00fa n\u00e3o me conhecia. Mas a vontade de brincar. --Tem raz\u00e3o, foi s\u00f3 nessa occasi\u00e3o que minha m\u00e3e era boa creatura. Quando lhe morreu o marido, Pedro de Albuquerque Santiago, contava trinta e um livro de _Horas..._ Quiz defendel-a, mas Capit\u00fa n\u00e3o parecia crer nem descrer, n\u00e3o parecia crer nem descrer, n\u00e3o parecia escutar a conversa\u00e7\u00e3o da minha alma. Todas essas bellas institui\u00e7\u00f5es sociaes me envolviam no seu mysterio, sem que.",
        "order": 2,
        "is_active": "0"
}
})
.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/admin/how-it-works

Permission required

how-it-works.create

Parameters

Parameter	Type	Validation	Description
name	string	required\|string\|max:191
text	string	nullable\|string\|max:10000
order	integer	required\|integer
is_active	boolean	boolean	Default true

Get additional information

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/how-it-works/additional-information",
    "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
});

{
    "next_order": 5
}

HTTP Request

GET api/v1/admin/how-it-works/additional-information

Export how it works

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/how-it-works/export",
    "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
});

{
    "file_url": "{url}"
}

HTTP Request

GET api/v1/admin/how-it-works/export

Permission required

how-it-works.export

Query Parameters

Parameter	Type	Validation	Description
orderBy	string	string	Default: `id:asc`. Available fields: `id` `name` `order` `is_active` `created_at` `updated_at`
search	string	string	Search in the fields: `uuid` `name` `email`
is_active	integer	integer	Available values: `0` `1`
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 how it works

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/how-it-works/{how_it_works}",
    "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
});

null

HTTP Request

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

Permission required

how-it-works.show

Update how it works

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/how-it-works/{how_it_works}",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "name": "Quibusdam deleniti qui est unde inventore veritatis eveniet harum.",
        "text": "Doloremque quae ea ut qui placeat. Ducimus voluptatem molestias labore dolor ullam corporis possimus. Ut laborum harum perspiciatis nihil provident. Provident fuga consequatur voluptate.",
        "order": 6,
        "is_active": "0"
}
})
.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/admin/how-it-works/{how_it_works}

Permission required

how-it-works.edit

Parameters

Parameter	Type	Validation
name	string	string\|max:191
text	string	nullable\|string\|max:10000
order	integer	required\|integer
is_active	boolean	boolean

Remove how it works

const axios = require('axios');

axios({
    "method": "delete",
    "url": "http://147.182.218.201:8447/api/v1/admin/how-it-works/{how_it_works}",
    "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/admin/how-it-works/{how_it_works}

Permission required

how-it-works.delete

Lideres de equipe

Get all lideres

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/lider",
    "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
});

null

HTTP Request

GET api/v1/admin/lider

Permission required

lider.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` `tipo_sociedade` `data_filiacao` `is_active` `created_at` `updated_at`
search	string	string	Search in the fields: `uuid` `name` `email` `documento` `representante_legal` `rg representante` `rg/inscricao`
is_active	integer	integer	Available values: `0` `1`
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

Create lider

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/lider",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "multipart/form-data",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "name": "Quibusdam et soluta dolore accusantium.",
        "avatar": "{file}",
        "cidade": "646729c4-d5cb-3608-aaba-6d2b6f935516",
        "email": "hfaro@example.com",
        "password": "123456",
        "street": "Dolore velit ea ut dolorem consectetur deleniti modi.",
        "district": "Vitae voluptatem veritatis velit expedita voluptatum autem ut tenetur.",
        "zipcode": "Voluptatem deleniti eum in accusamus dolore iure.",
        "number": "Veniam quod praesentium corrupti rem quia rerum sint.",
        "complement": "Praesentium accusamus illo dolorem eum placeat minima iste.",
        "phone": "Aut aut sapiente est mollitia harum.",
        "is_active": "0"
}
})
.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/admin/lider

Permission required

lider.create

Parameters

Parameter	Type	Validation
name	string	required\|string\|max:191
avatar	file	mimes:jpg,jpeg,png\|max:4mb
cidade	string	string\|max:191
email	email	required\|string\|email\|max:191
password	string	required\|string\|min:6
street	string	nullable\|string\|max:191
district	string	nullable\|string\|max:191
zipcode	string	nullable\|string\|max:191
number	string	nullable\|string\|max:191
complement	nullable\|string	string\|max:191
phone	string	nullable\|string\|max:191
is_active	boolean	boolean

Get all lideres excluidos

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/lider/deleted",
    "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
});

null

HTTP Request

GET api/v1/admin/lider/deleted

Permission required

lider.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` `tipo_sociedade` `data_filiacao` `is_active` `created_at` `updated_at`
search	string	string	Search in the fields: `uuid` `name` `email` `documento` `representante_legal` `rg representante` `rg/inscricao`
is_active	integer	integer	Available values: `0` `1`
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

Export lideres

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/lider/export",
    "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
});

{
    "file_url": "{url}"
}

HTTP Request

GET api/v1/admin/lider/export

Permission required

lider.export

Query Parameters

Parameter	Type	Validation	Description
orderBy	string	string	Default: `id:asc`. Available fields: `id` `name` `is_active` `created_at` `updated_at`
search	string	string	Search in the fields: `uuid` `name` `cpf` `tipo_sociedade`
is_active	integer	integer	Available values: `0` `1`
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

Autocomplete lider

List a maximum of 50 items.

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/lider/autocomplete",
    "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
});

null

HTTP Request

GET api/v1/admin/lider/autocomplete

Query Parameters

Parameter	Type	Validation	Description
orderBy	string	string	Default: `id:asc`. Available fields: `id` `name` `created_at` `updated_at`
search	string	string	Search in the fields: `uuid` `name`
is_active	integer	integer	Available values: `0` `1`

Get lider

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/lider/{customer}",
    "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
});

null

HTTP Request

GET api/v1/admin/lider/{customer}

Permission required

lider.show

Update lider

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/lider/{customer}",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "multipart/form-data",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "name": "Ullam voluptatum natus delectus sapiente qui.",
        "avatar": "{file}",
        "cidade": "d2b37156-b0aa-3944-ab8c-9e5c94f08985",
        "email": "massuncao@example.org",
        "street": "Sint molestiae enim et dolorem blanditiis accusantium.",
        "district": "Hic modi quia nobis sed est.",
        "zipcode": "Rem quam harum recusandae ut doloribus recusandae.",
        "number": "Inventore cupiditate impedit dolore ea.",
        "complement": "Vero eligendi eos enim temporibus alias totam quia.",
        "phone": "Aperiam laudantium voluptatem dolorem dolorem porro.",
        "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/admin/lider/{customer}

Permission required

lider.edit

Parameters

Parameter	Type	Validation
name	string	nullable\|string\|max:191
avatar	file	nullable\|mimes:jpg,jpeg,png\|max:4mb
cidade	string	nullable\|string\|max:191
email	email	nullable\|string\|email\|max:191
street	string	nullable\|string\|max:191
district	string	nullable\|string\|max:191
zipcode	string	nullable\|string\|max:191
number	string	nullable\|string\|max:191
complement	string	nullable\|string\|max:191
phone	string	nullable\|string\|max:191
is_active	boolean	nullable\|boolean

Remove lider

const axios = require('axios');

axios({
    "method": "delete",
    "url": "http://147.182.218.201:8447/api/v1/admin/lider/{customer}",
    "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/admin/lider/{customer}

Permission required

lider.delete

Log

Get all logs

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/logs",
    "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
});

null

HTTP Request

GET api/v1/admin/logs

Permission required

log.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` `user_id` `log_type` `log_id` `log_name` `message` `action` `ip` `user_agent` `url` `method` `created_at`
search	string	string	Search in the fields: `uuid` `user_id` `log_type` `log_id` `log_name` `message` `action` `ip` `user_agent` `url` `method`

Export logs

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/logs/export",
    "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
});

{
    "file_url": "{url}"
}

HTTP Request

GET api/v1/admin/logs/export

Permission required

log.export

Query Parameters

Parameter	Type	Validation	Description
orderBy	string	string	Default: `id:asc`. Available fields: `id` `user_id` `log_type` `log_id` `log_name` `message` `action` `ip` `user_agent` `url` `method` `created_at`
search	string	string	Search in the fields: `uuid` `user_id` `log_type` `log_id` `log_name` `message` `action` `ip` `user_agent` `url` `method`

Get log

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/logs/{log}",
    "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
});

null

HTTP Request

GET api/v1/admin/logs/{log}

Permission required

log.show

Obra

Export Obra

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/obra/export",
    "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
});

{
    "file_url": "{url}"
}

HTTP Request

GET api/v1/admin/obra/export

Permission required

obra.export

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

Get all obras

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/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
});

null

HTTP Request

GET api/v1/admin/obra

Permission required

obra.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` `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

Create obra

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/obra",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "nome": "Ducimus accusantium culpa non recusandae non facilis.",
        "metragem_total": "Omnis sint sequi ullam inventore neque debitis ea.",
        "customers[]": "5d853b8d-ff12-34c3-b663-80c4b647b38d",
        "cidade": "a9b344da-a861-3e64-987c-6801b0ff7d4b",
        "logradouro": "Voluptatibus quasi vel libero id.",
        "cep": "Numquam aut animi et sed sint.",
        "bairro": "Labore cumque blanditiis necessitatibus.",
        "numero": "Nisi sit natus velit aliquid quisquam autem facere.",
        "status": "`Para",
        "data_inicio": "2024-07-29T00:00:00-03:00",
        "data_fim": "2024-07-29T23:59:59-03:00",
        "is_active": "1",
        "nome_etapa[]": "Sequi aut laborum quas voluptas.",
        "dias_etapa[]": 3,
        "porcentagem_etapa[]": 3,
        "categoria_pecas[]": "Recusandae vel eum repellat voluptatum enim.",
        "montadas[]": 1,
        "descarregadas[]": 8,
        "tamanho[]": "Quia repellendus eius qui omnis illo fugiat."
}
})
.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/admin/obra

Permission required

obra.create

Parameters

Parameter	Type	Validation	Description
nome	string	required\|string\|max:191
metragem_total	decimal	required
customers[]	array	required\|array
cidade	string	nullable\|string\|max:191
logradouro	string	string\|max:191
cep	string	string\|max:191
bairro	string	string\|max:191
numero	string	string\|max:191
status	string	string	iniciar`) Available values:`Para iniciar`Andamento `Entregue` `Parado` `Na fila` `Pausada`
data_inicio	string	string	ISO 8601 `Y-m-d\TH:i:sP` Initial date
data_fim	string	string	ISO 8601 `Y-m-d\TH:i:sP` Final date
is_active	boolean	boolean	Default true
nome_etapa[]	array	required\|array	(max: 191 caracteres) Array de nome da etapa
dias_etapa[]	array	required\|array	Array de dias previsto da etapa, mesma ordem do array de nome_etapa
porcentagem_etapa[]	array	required\|array	Array da porcentagem que a etapa representa na obra, mesma ordem do array de nome_etapa
categoria_pecas[]	array	sometimes\|nullable\|array	(max: 191 caracteres) Array de nome de categoria de pecas
montadas[]	array	sometimes\|nullable\|array	Array de dias previsto da etapa, mesma ordem do array de categoria_pecas
descarregadas[]	array	sometimes\|nullable\|array	Array da porcentagem que a etapa representa na obra, mesma ordem do array de categoria_pecas
tamanho[]	array	sometimes\|nullable\|array	Array da porcentagem que a etapa representa na obra, mesma ordem do array de categoria_pecas

Get obra

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/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
});

null

HTTP Request

GET api/v1/admin/obra/{obra}

Permission required

obra.show

Update obra

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/obra/{obra}",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "nome": "Laudantium similique error sed laboriosam aut eum.",
        "metragem_total": "Autem enim eligendi rem dolor consequatur.",
        "cidade": "6392cee2-4736-3d0c-a7a4-7b7c0c06b49d",
        "uf": "38a21c50-946f-3cef-b496-5b474b98bd9a",
        "logradouro": "Aut perspiciatis vitae animi voluptatem.",
        "customers[]": "0338a34f-4086-36fb-8086-df1b421a1770",
        "cep": "Occaecati eos voluptate qui sed beatae animi.",
        "bairro": "Impedit molestias recusandae quidem ratione.",
        "numero": "Distinctio est iste quo occaecati corrupti culpa.",
        "status": "`Para",
        "data_inicio": "2024-07-29T00:00:00-03:00",
        "data_fim": "2024-07-29T23:59:59-03:00",
        "is_active": "1",
        "id_etapa[]": "739140b0-429e-37f1-b148-33a992fcab1e",
        "nome_etapa[]": "Aut voluptatem facere praesentium molestias consequatur eveniet.",
        "dias_etapa[]": 4,
        "order_etapa[]": 4,
        "porcentagem_etapa[]": 11,
        "categoria_pecas[]": "Nihil enim laborum quisquam.",
        "montadas[]": 3,
        "descarregadas[]": 7,
        "tamanho[]": "Quibusdam mollitia consequatur nostrum nobis voluptatum."
}
})
.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/admin/obra/{obra}

Permission required

obra.edit

Parameters

Parameter	Type	Validation	Description
nome	string	nullable\|string\|max:191
metragem_total	decimal	required
cidade	string	nullable\|string\|max:191
uf	string	nullable\|string\|max:191
logradouro	string	string\|max:191
customers[]	array	nullable\|array
cep	string	string\|max:191
bairro	string	string\|max:191
numero	string	string\|max:191
status	string	string	iniciar`) Available values:`Para iniciar`Andamento `Entregue` `Parado` `Na fila` `Pausada`
data_inicio	string	string	ISO 8601 `Y-m-d\TH:i:sP` Initial date
data_fim	string	string	ISO 8601 `Y-m-d\TH:i:sP` Final date
is_active	boolean	boolean	Default true
id_etapa[]	array	nullable\|array	Array dos uuid das etapas
nome_etapa[]	array	nullable\|array	(max: 191 caracteres) Array de nome da etapa
dias_etapa[]	array	nullable\|array	Array de dias previsto da etapa, mesma ordem do array de nome_etapa
order_etapa[]	array	nullable\|array	Array da porcentagem que a etapa representa na obra, mesma ordem do array de nome_etapa
porcentagem_etapa[]	array	nullable\|array	Array da porcentagem que a etapa representa na obra, mesma ordem do array de nome_etapa
categoria_pecas[]	array	nullable\|array	(max: 191 caracteres) Array de nome de categoria de pecas
montadas[]	array	nullable\|array	Array de dias previsto da etapa, mesma ordem do array de categoria_pecas
descarregadas[]	array	nullable\|array	Array da porcentagem que a etapa representa na obra, mesma ordem do array de categoria_pecas
tamanho[]	array	nullable\|array	Array da porcentagem que a etapa representa na obra, mesma ordem do array de categoria_pecas

Remove obra

const axios = require('axios');

axios({
    "method": "delete",
    "url": "http://147.182.218.201:8447/api/v1/admin/obra/{obra}",
    "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/admin/obra/{obra}

Permission required

obra.delete

OnBoarding

Get all onboardings

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/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
});

null

HTTP Request

GET api/v1/admin/onboarding

Permission required

onboarding.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` `frase` `frase2` `created_at`
search	string	string	Search in the fields: `frase` `frase2`

Create onboarding

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/onboarding",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "multipart/form-data",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "frase": "Rerum quam dolorem sed dolorum sunt et.",
        "frase2": "Ab repellat ut magni a quia temporibus corporis.",
        "ordem": "1",
        "is_active": "0",
        "file": "{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/admin/onboarding

Permission required

onboarding.create

Parameters

Parameter	Type	Validation	Description
frase	string	required\|string\|max:191
frase2	string	string\|max:191
ordem	integer	integer
is_active	boolean	boolean	Default true
file	file	mimes:jpg,jpeg,png,mp4,avi,mov,webm,mpg,ogg,mkv,flv\|max:8mb

Get additional information

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/onboarding/additional-information",
    "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
});

{
    "next_order": 5
}

HTTP Request

GET api/v1/admin/onboarding/additional-information

Get onboarding

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/onboarding/{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
});

null

HTTP Request

GET api/v1/admin/onboarding/{onboarding}

Permission required

onboarding.show

Update onboarding

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/onboarding/{onboarding}",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "multipart/form-data",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "frase": "Ratione ut dolor molestias aperiam.",
        "frase2": "Id rerum alias soluta mollitia animi.",
        "ordem": "1",
        "is_active": "1",
        "file": "{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/admin/onboarding/{onboarding}

Permission required

onboarding.edit

Parameters

Parameter	Type	Validation	Description
frase	string	nullable\|string\|max:191
frase2	string	nullable\|string\|max:191
ordem	integer	nullable\|integer
is_active	boolean	nullable\|boolean	Default true
file	file	mimes:jpg,jpeg,png,mp4,avi,mov,webm,mpg,ogg,mkv,flv\|max:8mb

Remove onboarding

const axios = require('axios');

axios({
    "method": "delete",
    "url": "http://147.182.218.201:8447/api/v1/admin/onboarding/{onboarding}",
    "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/admin/onboarding/{onboarding}

Permission required

onboarding.delete

Pecas

Get all peças

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/pecas",
    "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
});

null

HTTP Request

GET api/v1/admin/pecas

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

Create Peça

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/pecas",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "nome": "Cupiditate quam tempora fugiat ea voluptatum explicabo laboriosam.",
        "categoriapeca_id": "d0120e6d-9310-313a-8ce1-24797e8b96b8",
        "codigo": "Reprehenderit nulla deserunt placeat quas molestiae non officia.",
        "peso": "Delectus voluptatem qui consequatur aspernatur et.",
        "tamanho": "Velit aut voluptates labore perferendis maxime optio.",
        "estoque": "1",
        "qtd_caminhao": "1",
        "is_active": "0"
}
})
.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/admin/pecas

Permission required

peca.create

Parameters

Parameter	Type	Validation	Description
nome	string	required\|string\|max:191
categoriapeca_id	string	required\|string\|max:191
codigo	string	required\|string\|max:191
peso	numeric	required
tamanho	numeric	required
estoque	required\|integer	integer
qtd_caminhao	required\|integer	integer
is_active	boolean	boolean	Default true

Export peças

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/pecas/export",
    "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
});

{
    "file_url": "{url}"
}

HTTP Request

GET api/v1/admin/pecas/export

Permission required

peca.export

Query Parameters

Parameter	Type	Validation	Description
orderBy	string	string	Default: `id:asc`. Available fields: `id` `nome` `codigo`
search	string	string	Search in the fields: `uuid` `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

Get Peça

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/pecas/{peca}",
    "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
});

null

HTTP Request

GET api/v1/admin/pecas/{peca}

Permission required

peca.show

Update peça

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/pecas/{peca}",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "nome": "Expedita mollitia facilis eum voluptas debitis aperiam dolorum.",
        "categoriapeca_id": "a38edd54-c1a1-3445-83c2-2e8bc0dadaa4",
        "codigo": "Eveniet ex voluptate porro libero.",
        "peso": "Esse molestiae impedit quis aspernatur itaque sint dicta.",
        "tamanho": "Facere fugit debitis ut ut quidem non.",
        "estoque": "1",
        "qtd_caminhao": "1",
        "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/admin/pecas/{peca}

Permission required

pecas.edit

Parameters

Parameter	Type	Validation	Description
nome	string	sometimes\|nullable\|string\|max:191
categoriapeca_id	string	required\|string\|max:191
codigo	string	sometimes\|nullable\|string\|max:191
peso	numeric	sometimes\|nullable
tamanho	numeric	sometimes\|nullable
estoque	sometimes\|nullable\|integer	integer
qtd_caminhao	sometimes\|nullable\|integer	integer
is_active	boolean	sometimes\|nullable\|boolean	Default true

Remove peça

const axios = require('axios');

axios({
    "method": "delete",
    "url": "http://147.182.218.201:8447/api/v1/admin/pecas/{peca}",
    "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/admin/pecas/{peca}

Permission required

peca.delete

Permissions

Autocomplete permissions

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/permissions/autocomplete",
    "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
});

null

HTTP Request

GET api/v1/admin/permissions/autocomplete

Query Parameters

Parameter	Type	Validation	Description
orderBy	string	string	Default: `id:asc`. Available fields: `id` `key` `name` `group` `order` `created_at` `updated_at`
search	string	string	Search in the fields: `uuid` `key` `name` `group`

Privacy Policy

Get privacy policy

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/privacy-policy",
    "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
});

null

HTTP Request

GET api/v1/admin/privacy-policy

Permission required

privacy-policy.edit

Update privacy policy

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/privacy-policy",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "name": "Esse ipsa autem possimus porro repudiandae voluptas non optio.",
        "text": "Doloribus ullam voluptatum inventore quis alias alias doloremque. Nihil aut distinctio neque voluptas et qui repellat quibusdam."
}
})
.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/admin/privacy-policy

Permission required

privacy-policy.edit

Parameters

Parameter	Type	Validation	Description
name	string	string\|max:191
text	string	nullable\|string\|max:60000	HTML allowed

Profissional

Get all profissional

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/profissional",
    "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
});

null

HTTP Request

GET api/v1/admin/profissional

Permission required

profissional.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` `email` `avatar` `is_active` `created_at` `updated_at`
search	string	string	Search in the fields: `uuid` `name` `email`
is_active	integer	integer	Available values: `0` `1`
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

Create profissional

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/profissional",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "avatar": "{file}",
        "name": "Emanuel Guilherme Sanches Jr.",
        "documento": "Enim necessitatibus perspiciatis rerum.",
        "cidade": "0fe03037-7847-359b-a3ac-a900e4c99ab7",
        "email": "valencia.suzana@example.org",
        "phone": "Impedit eum inventore sit aut.",
        "zipcode": "Voluptatem molestiae laborum distinctio reiciendis nisi velit quae.",
        "street": "Quia sit consequatur possimus nulla ab.",
        "number": "Cum ab mollitia voluptas corrupti.",
        "complement": "Qui optio totam distinctio natus vel accusantium.",
        "district": "Dolorem necessitatibus maxime placeat tempore.",
        "is_active": "0"
}
})
.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/admin/profissional

Permission required

profissional.create

Parameters

Parameter	Type	Validation	Description
avatar	string	nullable\|mimes:jpeg,png\|max:4000
name	string	required\|string\|max:50
documento	string	required\|string\|max:191
cidade	string	nullable\|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
is_active	boolean	nullable\|boolean	Default true

Get all profissional

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/profissional/deleted",
    "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
});

null

HTTP Request

GET api/v1/admin/profissional/deleted

Permission required

profissional.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` `email` `avatar` `is_active` `created_at` `updated_at`
search	string	string	Search in the fields: `uuid` `name` `email`
is_active	integer	integer	Available values: `0` `1`
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

Export profissional

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/profissional/export",
    "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
});

{
    "file_url": "{url}"
}

HTTP Request

GET api/v1/admin/profissional/export

Permission required

profissional.export

Query Parameters

Parameter	Type	Validation	Description
orderBy	string	string	Default: `id:asc`. Available fields: `id` `name` `email` `avatar` `is_active` `created_at` `updated_at`
search	string	string	Search in the fields: `uuid` `name` `email`
is_active	integer	integer	Available values: `0` `1`
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 profissional

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/profissional/{profissional}",
    "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
});

null

HTTP Request

GET api/v1/admin/profissional/{profissional}

Permission required

profissional.show

Update profissional

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/profissional/{profissional}",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "name": "Mariah Correia Medina Filho",
        "documento": "Rerum nisi tempora cum quibusdam.",
        "cidade": "66f6489c-6978-3201-a83e-58748be80eff",
        "email": "juchoa@example.org",
        "phone": "Et placeat esse quos.",
        "zipcode": "Quae nostrum quia eveniet et.",
        "street": "Earum vel voluptatem est voluptatem adipisci quia pariatur.",
        "number": "Omnis id sed et et vel quasi.",
        "complement": "Dolor est amet sit rerum.",
        "district": "Asperiores ab quibusdam dolorum dignissimos eos ab.",
        "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/admin/profissional/{profissional}

Permission required

profissional.edit

Parameters

Parameter	Type	Validation	Description
name	string	sometime\|nullable\|string\|max:50
documento	string	sometime\|nullable\|string\|max:191
cidade	string	nullable\|string\|max:191
email	string	sometime\|nullable\|string\|email\|max:100
phone	string	sometime\|nullable\|string\|max:191
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	Default true

Remove profissional

const axios = require('axios');

axios({
    "method": "delete",
    "url": "http://147.182.218.201:8447/api/v1/admin/profissional/{profissional}",
    "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/admin/profissional/{profissional}

Permission required

profissional.delete

Push City

Get all push

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/push-city",
    "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
});

null

HTTP Request

GET api/v1/admin/push-city

Permission required

push-city.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` `title` `body` `scheduled_at` `send_at` `created_at` `city.name`
search	string	string	Search in the fields: `uuid` `title` `body` `city.name`
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

Create push

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/push-city",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "city_id": "2",
        "title": "Vel optio ut iste nihil dolores quia qui.",
        "body": "Alias sint libero et. Laudantium sed voluptatibus ipsa suscipit. Dolorem aut explicabo rerum aut.",
        "url": "http:\/\/www.sepulveda.net\/dolorem-et-ducimus-deleniti-fugiat-qui-sit",
        "scheduled_at": "2019-07-29T23:59:59-03:00"
}
})
.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/admin/push-city

Permission required

push-city.create

Parameters

Parameter	Type	Validation	Description
city_id	integer	required\|integer	`City` relationship
title	string	required\|string\|max:50
body	string	required\|string\|max:100
url	string	nullable\|string\|max:191
scheduled_at	string	nullable\|string	ISO 8601 `Y-m-d\TH:i:sP` Future date

Export push

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/push-city/export",
    "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
});

{
    "file_url": "{url}"
}

HTTP Request

GET api/v1/admin/push-city/export

Permission required

push-city.export

Query Parameters

Parameter	Type	Validation	Description
orderBy	string	string	Default: `id:asc`. Available fields: `id` `title` `body` `scheduled_at` `send_at` `created_at` `city.name`
search	string	string	Search in the fields: `uuid` `title` `body` `city.name`
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 push

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/push-city/{push}",
    "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
});

null

HTTP Request

GET api/v1/admin/push-city/{push}

Permission required

push-city.show

Remove push

const axios = require('axios');

axios({
    "method": "delete",
    "url": "http://147.182.218.201:8447/api/v1/admin/push-city/{push}",
    "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/admin/push-city/{push}

Permission required

push-city.delete

Push General

Get all push

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/push-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
});

null

HTTP Request

GET api/v1/admin/push-general

Permission required

push-general.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` `title` `body` `scheduled_at` `send_at` `created_at`
search	string	string	Search in the fields: `uuid` `title` `body`
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

Create push

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/push-general",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "title": "Aut est est quam exercitationem possimus.",
        "body": "Voluptatibus voluptas ipsum laudantium. Modi et sed beatae velit itaque quis voluptas corrupti.",
        "url": "http:\/\/www.madeira.com\/et-labore-iusto-in-earum-natus-non",
        "scheduled_at": "2019-07-29T23:59:59-03:00"
}
})
.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/admin/push-general

Permission required

push-general.create

Parameters

Parameter	Type	Validation	Description
title	string	required\|string\|max:50
body	string	required\|string\|max:100
url	string	nullable\|string\|max:191
scheduled_at	string	nullable\|string	ISO 8601 `Y-m-d\TH:i:sP` Future date

Export push

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/push-general/export",
    "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
});

{
    "file_url": "{url}"
}

HTTP Request

GET api/v1/admin/push-general/export

Permission required

push-general.export

Query Parameters

Parameter	Type	Validation	Description
orderBy	string	string	Default: `id:asc`. Available fields: `id` `title` `body` `scheduled_at` `send_at` `created_at`
search	string	string	Search in the fields: `uuid` `title` `body`
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 push

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/push-general/{push}",
    "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
});

null

HTTP Request

GET api/v1/admin/push-general/{push}

Permission required

push-general.show

Remove push

const axios = require('axios');

axios({
    "method": "delete",
    "url": "http://147.182.218.201:8447/api/v1/admin/push-general/{push}",
    "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/admin/push-general/{push}

Permission required

push-general.delete

Push State

Get all push

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/push-state",
    "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
});

null

HTTP Request

GET api/v1/admin/push-state

Permission required

push-state.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` `title` `body` `scheduled_at` `send_at` `created_at` `state.name`
search	string	string	Search in the fields: `uuid` `title` `body` `state.name`
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

Create push

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/push-state",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "state_id": "2",
        "title": "Qui ab et sapiente distinctio ut atque.",
        "body": "Minima pariatur voluptatem labore tempore delectus suscipit vitae. Quis consequuntur alias non.",
        "url": "http:\/\/matos.com.br\/facilis-quisquam-corporis-repudiandae-ipsam-unde-quos.html",
        "scheduled_at": "2019-07-29T23:59:59-03:00"
}
})
.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/admin/push-state

Permission required

push-state.create

Parameters

Parameter	Type	Validation	Description
state_id	integer	required\|integer	`State` relationship
title	string	required\|string\|max:50
body	string	required\|string\|max:100
url	string	nullable\|string\|max:191
scheduled_at	string	nullable\|string	ISO 8601 `Y-m-d\TH:i:sP` Future date

Export push

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/push-state/export",
    "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
});

{
    "file_url": "{url}"
}

HTTP Request

GET api/v1/admin/push-state/export

Permission required

push-state.export

Query Parameters

Parameter	Type	Validation	Description
orderBy	string	string	Default: `id:asc`. Available fields: `id` `title` `body` `scheduled_at` `send_at` `created_at` `state.name`
search	string	string	Search in the fields: `uuid` `title` `body` `state.name`
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 push

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/push-state/{push}",
    "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
});

null

HTTP Request

GET api/v1/admin/push-state/{push}

Permission required

push-state.show

Remove push

const axios = require('axios');

axios({
    "method": "delete",
    "url": "http://147.182.218.201:8447/api/v1/admin/push-state/{push}",
    "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/admin/push-state/{push}

Permission required

push-state.delete

Push User

Get all push

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/push-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
});

null

HTTP Request

GET api/v1/admin/push-user

Permission required

push-user.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` `title` `body` `scheduled_at` `send_at` `created_at` `user.name`
search	string	string	Search in the fields: `uuid` `title` `body` `user.name`
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

Create push

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/push-user",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "user_id": "fb708c71-a61d-320c-8a08-4237a81fa806",
        "title": "Quod delectus repellat rerum nisi.",
        "body": "Modi aperiam officia magnam. Dolor eum ratione quo beatae. Est sunt libero possimus perferendis.",
        "url": "http:\/\/gomes.net.br\/dolores-numquam-commodi-et-ullam-rem.html",
        "scheduled_at": "2019-07-29T23:59:59-03:00"
}
})
.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/admin/push-user

Permission required

push-user.create

Parameters

Parameter	Type	Validation	Description
user_id	integer	required\|uuid	`Customer user` relationship
title	string	required\|string\|max:50
body	string	required\|string\|max:100
url	string	nullable\|string\|max:191
scheduled_at	string	nullable\|string	ISO 8601 `Y-m-d\TH:i:sP` Future date

Export push

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/push-user/export",
    "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
});

{
    "file_url": "{url}"
}

HTTP Request

GET api/v1/admin/push-user/export

Permission required

push-user.export

Query Parameters

Parameter	Type	Validation	Description
orderBy	string	string	Default: `id:asc`. Available fields: `id` `title` `body` `scheduled_at` `send_at` `created_at` `user.name`
search	string	string	Search in the fields: `uuid` `title` `body` `user.name`
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 push

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/push-user/{push}",
    "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
});

null

HTTP Request

GET api/v1/admin/push-user/{push}

Permission required

push-user.show

Remove push

const axios = require('axios');

axios({
    "method": "delete",
    "url": "http://147.182.218.201:8447/api/v1/admin/push-user/{push}",
    "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/admin/push-user/{push}

Permission required

push-user.delete

Rich Text Editor

Upload image

const axios = require('axios');

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

{
    "url": "{url}"
}

HTTP Request

POST api/v1/admin/rich-text-editor/upload-image

Parameters

Parameter	Type	Validation	Description
upload	file	required\|mimes:jpeg,png\|max:2mb

Roles

Get all roles

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/roles",
    "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
});

null

HTTP Request

GET api/v1/admin/roles

Permission required

roles.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` `description` `is_system` `created_at` `updated_at` `permissions_count` `users_count`
search	string	string	Search in the fields: `uuid` `name` `description`
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

Create role

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/roles",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "name": "Manager",
        "description": "Quia nihil dolor illo commodi sunt. Ab delectus voluptatem quae omnis minima.",
        "permissions[0]": "dbe015d8-d1e1-3421-9894-96cdd41929c1"
}
})
.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/admin/roles

Permission required

roles.create

Parameters

Parameter	Type	Validation
name	string	required\|string\|max:50
description	string	required\|string\|max:100
permissions[]	array	required\|array\|min:1
permissions[0]	uuid	required\|uuid

Autocomplete roles

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/roles/autocomplete",
    "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
});

null

HTTP Request

GET api/v1/admin/roles/autocomplete

Query Parameters

Parameter	Type	Validation	Description
orderBy	string	string	Default: `id:asc`. Available fields: `id` `name` `description` `is_system` `created_at` `updated_at`
search	string	string	Search in the fields: `uuid` `name` `description`

Export roles

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/roles/export",
    "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
});

{
    "file_url": "{url}"
}

HTTP Request

GET api/v1/admin/roles/export

Permission required

roles.export

Query Parameters

Parameter	Type	Validation	Description
orderBy	string	string	Default: `id:asc`. Available fields: `id` `name` `description` `is_system` `created_at` `updated_at` `permissions_count` `users_count`
search	string	string	Search in the fields: `uuid` `name` `description`
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 role

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/roles/{role}",
    "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
});

null

HTTP Request

GET api/v1/admin/roles/{role}

Permission required

roles.show

Update role

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/roles/{role}",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "name": "Libero quis facere quo sed aut.",
        "description": "Doloribus et debitis itaque dolore. Aut neque incidunt ducimus fuga non nam unde iure.",
        "permissions[0]": "9b11a2fc-28a3-3a77-a2aa-5439e790fd57"
}
})
.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/admin/roles/{role}

Permission required

roles.edit

Parameters

Parameter	Type	Validation
name	string	string\|max:50
description	string	required\|string\|max:100
permissions[]	array	array\|min:1
permissions[0]	uuid	required\|uuid

Remove role

const axios = require('axios');

axios({
    "method": "delete",
    "url": "http://147.182.218.201:8447/api/v1/admin/roles/{role}",
    "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/admin/roles/{role}

Permission required

roles.delete

Settings General

Get settings

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/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
});

null

HTTP Request

GET api/v1/admin/settings/general

Permission required

settings-general.list

Update settings

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/settings/general",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "app_url_android": "https:\/\/play.google.com\/store\/apps\/details?id=com.facebook.katana",
        "app_url_ios": "https:\/\/apps.apple.com\/br\/app\/facebook\/id284882215",
        "email_support": "ilira@example.org"
}
})
.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/admin/settings/general

Permission required

settings-general.edit

Parameters

Parameter	Type	Validation
app_url_android	string	nullable\|string\|url
app_url_ios	string	nullable\|string\|url
email_support	string	string\|email

Settings Notifications

Get settings

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/settings/notifications",
    "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
});

null

HTTP Request

GET api/v1/admin/settings/notifications

Permission required

settings-notifications.list

Update settings

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/settings/notifications",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "report_a_problem[0]": "rrezende@example.com"
}
})
.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/admin/settings/notifications

Permission required

settings-notifications.edit

Parameters

Parameter	Type	Validation	Description
report_a_problem[]	array	array\|min:1
report_a_problem[0]	string	required\|email

System Log

Get all logs

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/system-log",
    "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
});

null

HTTP Request

GET api/v1/admin/system-log

Permission required

system-log.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` `message` `url` `created_at`
search	string	string	Search in the fields: `uuid` `message` `url`
level	string	string	Available values: `ALERT` `CRITICAL` `DEBUG` `EMERGENCY` `ERROR` `INFO` `NOTICE` `WARNING`
method	string	string	Available values: `DELETE` `GET` `POST`
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

Export logs

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/system-log/export",
    "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
});

{
    "file_url": "{url}"
}

HTTP Request

GET api/v1/admin/system-log/export

Permission required

system-log.export

Query Parameters

Parameter	Type	Validation	Description
orderBy	string	string	Default: `id:asc`. Available fields: `id` `message` `url` `created_at`
search	string	string	Search in the fields: `uuid` `message` `url`
level	string	string	Available values: `ALERT` `CRITICAL` `DEBUG` `EMERGENCY` `ERROR` `INFO` `NOTICE` `WARNING`
method	string	string	Available values: `DELETE` `GET` `POST`
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 log

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/system-log/{log}",
    "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
});

null

HTTP Request

GET api/v1/admin/system-log/{log}

Permission required

system-log.show

Terms Of Use

Get terms of use

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/terms-of-use",
    "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
});

null

HTTP Request

GET api/v1/admin/terms-of-use

Permission required

terms-of-use.edit

Update terms of use

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/terms-of-use",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "name": "Qui doloremque sed tempore consequatur laborum aut.",
        "text": "Pariatur et tempora velit et. Reiciendis nemo omnis qui nam. Maiores ad minus voluptas et quia vel. Ea nisi est tempora voluptatum accusantium quaerat. Placeat esse dignissimos ea inventore."
}
})
.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/admin/terms-of-use

Permission required

terms-of-use.edit

Parameters

Parameter	Type	Validation	Description
name	string	string\|max:191
text	string	nullable\|string\|max:60000	HTML allowed

Users

Get all users

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/users",
    "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
});

null

HTTP Request

GET api/v1/admin/users

Permission required

users.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` `email` `avatar` `is_active` `created_at` `updated_at`
search	string	string	Search in the fields: `uuid` `name` `email`
is_active	integer	integer	Available values: `0` `1`
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

Create user

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/users",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "avatar": "{file}",
        "name": "Nayara Noa Barros Jr.",
        "password_random": "1",
        "password": "123456",
        "password_confirmation": "123456",
        "email": "clarice.pedrosa@example.net",
        "is_active": "0",
        "roles[0]": "84b2abc6-988a-3fe3-8153-efca7fa07b39"
}
})
.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/admin/users

Permission required

users.create

Parameters

Parameter	Type	Validation	Description
avatar	string	nullable\|mimes:jpeg,png\|max:4000
name	string	required\|string\|max:50
password_random	boolean	required\|boolean
password	string	required_if:password_random,0\|string\|min:6
password_confirmation	string	required_if:password_random,0\|string\|min:6	Must contain the same value as `password`
email	string	required\|string\|email\|max:100
is_active	boolean	boolean	Default true
roles[]	array	array\|min:1
roles[0]	uuid	required\|uuid

Autocomplete users

List a maximum of 50 items.

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/users/autocomplete",
    "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
});

null

HTTP Request

GET api/v1/admin/users/autocomplete

Query Parameters

Parameter	Type	Validation	Description
orderBy	string	string	Default: `id:asc`. Available fields: `id` `name` `created_at` `updated_at`
search	string	string	Search in the fields: `uuid` `name`
is_active	integer	integer	Available values: `0` `1`

Export users

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/users/export",
    "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
});

{
    "file_url": "{url}"
}

HTTP Request

GET api/v1/admin/users/export

Permission required

users.export

Query Parameters

Parameter	Type	Validation	Description
orderBy	string	string	Default: `id:asc`. Available fields: `id` `name` `email` `avatar` `is_active` `created_at` `updated_at`
search	string	string	Search in the fields: `uuid` `name` `email`
is_active	integer	integer	Available values: `0` `1`
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 user

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/users/{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
});

null

HTTP Request

GET api/v1/admin/users/{user}

Permission required

users.show

Update user

const axios = require('axios');

axios({
    "method": "post",
    "url": "http://147.182.218.201:8447/api/v1/admin/users/{user}",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "is_active": "1",
        "roles[0]": "effdb1a7-eee0-3858-8fc6-a0182b9b6395"
}
})
.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/admin/users/{user}

Permission required

users.edit

Parameters

Parameter	Type	Validation
is_active	boolean	boolean
roles[]	array	array\|min:1
roles[0]	uuid	required\|uuid

Remove user

const axios = require('axios');

axios({
    "method": "delete",
    "url": "http://147.182.218.201:8447/api/v1/admin/users/{user}",
    "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/admin/users/{user}

Permission required

users.delete

Webservice

Cities

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

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/webservice/cities",
    "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
});

null

HTTP Request

GET api/v1/admin/webservice/cities

Query Parameters

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

States

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/webservice/states",
    "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
});

null

HTTP Request

GET api/v1/admin/webservice/states

Query Parameters

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

Find zipcode

const axios = require('axios');

axios({
    "method": "get",
    "url": "http://147.182.218.201:8447/api/v1/admin/webservice/zipcode/{zipcode}",
    "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
});

null

HTTP Request

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