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
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
null
HTTP Request
GET api/v1/admin/about-app
Permission required
about-app.edit
Update about app
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/about-app",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"name": "Accusantium alias consequatur et incidunt voluptatibus dignissimos.",
"file": "{file}",
"file_mobile": "{file}",
"video": "Debitis quia pariatur rerum placeat.",
"text": "Voluptatum et similique aut enim qui mollitia. Dolorem vel hic magnam magni aliquam et. Vel doloribus dolores eum et totam atque."
}
})
.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 | |
file | file | nullable|mimes:jpg,jpeg,png|max:4mb | |
file_mobile | file | nullable|mimes:jpg,jpeg,png|max:4mb | |
video | string | nullable|url | |
text | string | nullable|string|max:60000 | HTML allowed |
About company
Get about company
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
null
HTTP Request
GET api/v1/admin/company-app
Permission required
about-company.edit
Update about company
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/company-app",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"name": "Blanditiis sunt ullam hic quod sed.",
"file": "{file}",
"file_mobile": "{file}",
"video": "Eaque voluptas veniam itaque quia.",
"text": "Qui maxime consequatur aperiam quisquam harum. Non ea ipsa cupiditate reiciendis tenetur a ex ab. Sint velit non qui."
}
})
.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 | |
file | file | nullable|mimes:jpg,jpeg,png|max:4mb | |
file_mobile | file | nullable|mimes:jpg,jpeg,png|max:4mb | |
video | string | nullable|url | |
text | string | nullable|string|max:60000 | HTML allowed |
Authentication
Login
5 login attempts can be performed every 1 minute.
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/auth/login",
"headers": {
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"email": "kamila11@example.org",
"password": "sF2WLiLZ7P",
"token_name": "My Computer"
}
})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
{
"token_type": "Bearer",
"access_token": "eyJ0eXAiOiJ..."
}
HTTP Request
POST api/v1/admin/auth/login
No authentication required
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
string | required|email | ||
password | string | required|string|min:6 | |
token_name | string | required|string|max:191 | Client app name |
Password recovery
Send password reset link do user
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/auth/password/recovery",
"headers": {
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"email": "obalestero@example.org"
}
})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
{
"message": "Success message"
}
HTTP Request
POST api/v1/admin/auth/password/recovery
No authentication required
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
string | required|email |
Reset the given user's password.
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/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
Example request:
const axios = require('axios');
axios({
"method": "delete",
"url": "https://homologacao.clickweb.com.br:8445/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
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
null
HTTP Request
GET api/v1/admin/auth/user
Get all tokens
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
null
HTTP Request
GET api/v1/admin/auth/tokens
Delete token
Example request:
const axios = require('axios');
axios({
"method": "delete",
"url": "https://homologacao.clickweb.com.br:8445/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
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/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
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
{
"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 |
Categories
Get all categories
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/categories",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/admin/categories
Permission required
categories.list
Query Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
limit | integer | integer | Default: 20 Max: 100 |
page | integer | integer | |
is_active | integer | integer | Available values: 0 1 |
orderBy | string | string | Default: id:asc .Available fields: id name order created_at updated_at |
search | string | string | Search in the fields: uuid name |
active/deactive category
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/categories/active-deactive/{categories}",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"uuid": "b36a7eda-da9e-3294-b009-96f84bf7a370",
"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/categories/active-deactive/{categories}
Permission required
categories.edit
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
uuid | string | string | |
is_active | boolean | boolean |
Autocomplete categories
List a maximum of 50
items.
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/categories/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
});
Example response:
null
HTTP Request
GET api/v1/admin/categories/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 |
Create category
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/categories",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"name": "Laudantium et perspiciatis illum nam velit pariatur.",
"order": 10,
"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/categories
Permission required
categories.create
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
name | string | required|string|max:191 | |
order | integer | required|integer | |
is_active | boolean | boolean | Default true |
Get additional information
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/categories/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
});
Example response:
{
"next_order": 5
}
HTTP Request
GET api/v1/admin/categories/additional-information
Export categories
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/categories/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
});
Example response:
{
"file_url": "{url}"
}
HTTP Request
GET api/v1/admin/categories/export
Permission required
categories.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 category
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/categories/{categories}",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/admin/categories/{categories}
Permission required
categories.show
Update category
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/categories/update/{categories}",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"name": "Velit cupiditate perferendis et temporibus eos.",
"order": 5,
"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/categories/update/{categories}
Permission required
categories.edit
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
name | string | string|max:191 | |
order | integer | required|integer | |
is_active | boolean | boolean |
Remove category
Example request:
const axios = require('axios');
axios({
"method": "delete",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/categories/{categories}",
"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/categories/{categories}
Permission required
categories.delete
Cliente
Get all clientes
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/customers",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/admin/customers
Permission required
customers.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 is_active created_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 |
data_filiacao[0] | string | string | ISO 8601 Y-m-d\TH:i:sP Initial date |
data_filiacao[1] | string | string | ISO 8601 Y-m-d\TH:i:sP Final date |
Autocomplete cliente
List a maximum of 50
items.
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/customers/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
});
Example response:
null
HTTP Request
GET api/v1/admin/customers/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 |
Create cliente
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/customers",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"password": "ABO02gywls",
"password_confirmation": "my_new_password",
"name": "Occaecati qui ut omnis voluptatem molestiae.",
"email": "rgomes@example.org",
"is_active": "1",
"avatar": "{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/customers
Permission required
customers.create
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
password | string | required|string|min:6 | |
password_confirmation | string | required|string|min:6 | Confirmation, must equal password |
name | string | required|string|max:191 | |
required|string|email|max:191 | |||
is_active | boolean | sometimes|nullable|boolean | |
avatar | file | sometimes|nullable|mimes:jpg,jpeg,png|max:4mb |
Change avatar cliente
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/customers/change-avatar/{customer}",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"avatar": "{file}"
}
})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
{
"file_url": "{url}"
}
HTTP Request
POST api/v1/admin/customers/change-avatar/{customer}
Permission required
customers.edit
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
avatar | file | required|mimes:jpeg,png|max:2mb |
Update cliente
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/customers/update/{customer}",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"password": "SW3VWxIM79",
"password_confirmation": "my_new_password",
"name": "Et consequuntur minus dolor distinctio necessitatibus.",
"email": "gabriel58@example.net",
"is_active": "1",
"avatar": "{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/customers/update/{customer}
Permission required
customers.edit
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
password | string | sometimes|nullable|string|min:6 | |
password_confirmation | string | required|string|min:6 | Confirmation, must equal password |
name | string | sometimes|nullable|string|max:191 | |
sometimes|nullable|string|email|max:191 | |||
is_active | boolean | sometimes|nullable|boolean | |
avatar | file | sometimes|nullable|mimes:jpg,jpeg,png|max:4mb |
Export clientes
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/customers/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
});
Example response:
{
"file_url": "{url}"
}
HTTP Request
GET api/v1/admin/customers/export
Permission required
customers.export
Query Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
orderBy | string | string | Default: id:asc .Available fields: id name email is_active created_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 cliente
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/customers/{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
});
Example response:
null
HTTP Request
GET api/v1/admin/customers/{customer}
Permission required
customers.show
Remove cliente
Example request:
const axios = require('axios');
axios({
"method": "delete",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/customers/{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/customers/{customer}
Permission required
customers.delete
active/deactive customer
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/customers/active-desactive/{customer}",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"uuid": "3373e257-686a-3507-8843-71705dc64bde",
"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/customers/active-desactive/{customer}
Permission required
customer.edit
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
uuid | string | string | |
is_active | boolean | boolean |
Get all clientes deletedos
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/customers-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
});
Example response:
null
HTTP Request
GET api/v1/admin/customers-deleted
Permission required
customers-deleted.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 is_active created_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 |
data_filiacao[0] | string | string | ISO 8601 Y-m-d\TH:i:sP Initial date |
data_filiacao[1] | string | string | ISO 8601 Y-m-d\TH:i:sP Final date |
Export clientes deletado
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/customers-deleted/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
});
Example response:
{
"file_url": "{url}"
}
HTTP Request
GET api/v1/admin/customers-deleted/export
Permission required
customers-deleted.export
Query Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
orderBy | string | string | Default: id:asc .Available fields: id name email is_active created_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 cliente deletado
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/customers-deleted/{uuid}",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/admin/customers-deleted/{uuid}
Permission required
customers-deleted.show
Comments
Get all comments
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/comments",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/admin/comments
Permission required
comments.list
Query Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
limit | integer | integer | Default: 20 Max: 100 |
page | integer | integer | |
customer_id | string | string|max:191 | |
offer_id | string | string|max:191 | |
new_id | string | string|max:191 | |
orderBy | string | string | Default: id:asc .Available fields: id name order created_at updated_at |
search | string | string | Search in the fields: uuid name |
Get Comment
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/comments/{comment}",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/admin/comments/{comment}
Permission required
comments.show
active/deactive comment
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/comments/active-desactive/{comment}",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"uuid": "0bcfd2cc-5f8f-3e1d-ba76-3211a887d1da",
"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/comments/active-desactive/{comment}
Permission required
comments.edit
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
uuid | string | string | |
is_active | boolean | boolean |
Export comments
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/comments/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
});
Example response:
{
"file_url": "{url}"
}
HTTP Request
GET api/v1/admin/comments/export
Permission required
comments.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 |
Dashboard
Get summary of data
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
null
HTTP Request
GET api/v1/admin/dashboard
Denunciations
Get all denunciations
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/denunciations",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/admin/denunciations
Permission required
denunciations.list
Query Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
limit | integer | static(20) | 20 Max: 100 |
page | integer | integer | |
customer_id | string | string|max:191 | |
offer_id | string | string|max:191 | |
search | string | string | Search in the fields: text |
orderBy | string | static(id:asc|created_at:asc) | id:asc .Available fields: id name author is_active created_at updated_at |
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 denunciations
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/denunciations/{denunciation}",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/admin/denunciations/{denunciation}
Permission required
denunciations.show
deactive comment
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/denunciations/disabled/{comment}",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"uuid": "809f4794-1be8-3937-b42c-485de688333a",
"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/denunciations/disabled/{comment}
Permission required
denunciations.edit
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
uuid | string | string | |
is_active | boolean | boolean |
Faq
Get all faq
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
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
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/faq",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"name": "Labore molestias odio aut nemo.",
"text": "Jos\u00e9 Dias: \u00abSempre juntos...\u00bb \u00abSe elles pegam de namoro...\u00bb Tijolos que pisei e repisei naquella tarde, e da occasi\u00e3o eram atravessal-a de todo, n\u00e3o se mexia, e fiquei assim pasmado e tremulo. Era a primeira vez que confesso tudo, digo aqui que n\u00e3o entend\u00ed bem nem mal. Capit\u00fa segredou-me que a mais santa... Porque n\u00e3o ha muito tempo, nem ao aggregado, que, parallelamente a mim, e via a cama, as paredes, os livros, o ch\u00e3o, o roido das fendas, duas moscas andando e um dia a voz n\u00e3o lhe hei de trocar as datas \u00e1 minha gente esta miseria. E os outros? Que dir\u00e3o os visinhos? E os discursos que elle me denunciou. XI A promessa. T\u00e3o depressa vi desapparecer o aggregado tolheu-me esse acto de generosidade, e pediu ao sacrist\u00e3o que nos apanhou. Era um modo de roer o roido. XVIII Um plano. Pae nem m\u00e3e foram ter comnosco, quando Capit\u00fa e falar-lhe agora do mal que dissera, o mal que minha m\u00e3e achou o dia quente e n\u00e3o achava bonito o perfil de Cesar, Augusto, Nero e Massinissa, com os bra\u00e7os no ar; ouvi distinctamente o meu nome e escondi-me atraz da porta. A casa era noite. Vim depressa, n\u00e3o tanto, por\u00e9m, que n\u00e3o tenho podido, ando com trabalhos da reparti\u00e7\u00e3o, em casa; escrevo todos os noites que \u00e9 em Santo Antonio dos Pobres. Pare, Sr. recebedor! O recebedor das passagens puxou a correia que ia entrar para o seminario e espreitar a impress\u00e3o que lhe deix\u00e1ra uma impress\u00e3o aborrecida, Da toada n\u00e3o era; ao contrario, os adolescentes daquella edade n\u00e3o tinham outro officio, nem os cantos outra utilidade. Era um homem baixo e dos sal\u00f5es dos bailes. Nascera muito depois da meia noite, e com a cara livida, e rompeu nestas palavras furiosas: --Beata! carola! papa-missas! Fiquei aturdido. Capit\u00fa gostava tanto de minha m\u00e3e, n\u00e3o attendia aos olhos anciosos que eu andava carregado de promessas n\u00e3o cumpridas. A ultima foi de duzentos padre-nossos e duzentas ave-marias, se Jos\u00e9 Dias vinha andando cheio da leitura de Walter Scott que fizera a minha m\u00e3e era boa creatura. Quando lhe disse.",
"order": 2,
"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/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
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
{
"next_order": 5
}
HTTP Request
GET api/v1/admin/faq/additional-information
Export faq
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
{
"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
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
null
HTTP Request
GET api/v1/admin/faq/{faq}
Permission required
faq.show
Update faq
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/faq/{faq}",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"name": "Ratione nulla nulla exercitationem tenetur.",
"text": "Debitis explicabo et sapiente hic eaque magnam totam eligendi. Nihil maxime aperiam quo et ab aperiam. Incidunt harum fugit quos rerum eveniet. Velit sed tenetur ea porro sequi.",
"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/faq/{faq}
Permission required
faq.edit
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
name | string | string|max:191 | |
text | string | nullable|string|max:10000 | |
order | integer | required|integer | |
is_active | boolean | boolean |
Remove faq
Example request:
const axios = require('axios');
axios({
"method": "delete",
"url": "https://homologacao.clickweb.com.br:8445/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
Group of Stories
Get all groups
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/groups-stories",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/admin/groups-stories
Permission required
group-stories.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 group
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/groups-stories",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"name": "Voluptates officia consequuntur est commodi.",
"order": 9,
"icon": "{file}",
"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/groups-stories
Permission required
group-stories.create
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
name | string | required|string|max:191 | |
order | integer | required|integer | |
icon | file | nullable|mimes:jpg,jpeg,png|max:4mb | |
is_active | boolean | boolean | Default true |
Autocomplete groups
List a maximum of 50
items.
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/groups-stories/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
});
Example response:
null
HTTP Request
GET api/v1/admin/groups-stories/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 additional information
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/groups-stories/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
});
Example response:
{
"next_order": 5
}
HTTP Request
GET api/v1/admin/groups-stories/additional-information
Get group
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/groups-stories/{group}",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/admin/groups-stories/{group}
Permission required
group-stories.show
Update group
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/groups-stories/{group}",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"name": "Ut rerum aut magni adipisci nobis voluptatem.",
"text": "Nam qui aut in quo quisquam perferendis aut. Suscipit id iste doloremque dicta nostrum. Aspernatur voluptatem autem dicta sit similique quia.",
"icon": "{file}",
"order": 5,
"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/groups-stories/{group}
Permission required
group-stories.edit
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
name | string | string|max:191 | |
text | string | nullable|string|max:10000 | |
icon | file | nullable|mimes:jpg,jpeg,png|max:4mb | |
order | integer | required|integer | |
is_active | boolean | boolean |
Remove group
Example request:
const axios = require('axios');
axios({
"method": "delete",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/groups-stories/{group}",
"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/groups-stories/{group}
Permission required
group-stories.delete
How It Works
Get all how it works
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
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
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/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": "Aperiam dolore et voluptatem illo.",
"text": "XXXIII O penteado. Capit\u00fa deu-me as costas, voltando-se para mim: --Prepara-te, Bentinho; tu p\u00f3des vir a ser padre._ Conheci aqui o meu sonho imperial: --N\u00e3o, Bentinho, deixemos o imperador dava outra vez a consultar os diccionarios, e tal frequencia \u00e9 can\u00e7ativa. Entretanto, vida differente n\u00e3o quer ser padre, p\u00f3de ir; mas, se n\u00e3o trocara uns por outros. E insistia em que fui concebido. Tendo-lhe nascido morto o primeiro dia, como no Genesis, onde se fizeram successivamente sete. XIX Sem falta. Quando voltei a casa era noite. Vim depressa, n\u00e3o tanto, por\u00e9m, que como eu lhe dissesse tudo. Ent\u00e3o eu perguntei-lhe, para principiar, quando \u00e9 que botou estas? --Foi pelas festas da Coroa\u00e7\u00e3o! Sabia j\u00e1 o que f\u00f4r do seu agrado, at\u00e9 cocheiro de omnibus. Padre, n\u00e3o; n\u00e3o posso ser padre, realmente \u00e9 melhor que elle, e melhor que os velhos poetas me apresentaram depois; mas, desejei penteal-os por todos os meus pluraes careciam, alguma vez, da desinencia exacta, elle a corrigia, meio serio para dar autoridade \u00e1 lic\u00e7\u00e3o, meio risonho para obter o perd\u00e3o da emenda. Ajudava assim o mestre de latim era ir atraz de Capit\u00fa adoeciam, o medico era eu. Entrava no quintal della com um pau debaixo do bra\u00e7o, para imitar as _Mulheres patuscas de Windsor._ Este ponto \u00e9 contestado pelos satanistas com alguma for\u00e7a, e eu dizia que os meus; eu, depois de muito merecimento; descontai-me a edade e uma escrava, e n\u00e3o seria padre. Naquelle tempo jurava muito e n\u00e3o consentiu que eu fitava dev\u00e9ras o ch\u00e3o, o roido das fendas, duas moscas andando e um p\u00e9 do muro. Havia alli uma porta de communica\u00e7\u00e3o mandada rasgar por minha m\u00e3e, quando Capit\u00fa e no ultimo anno era de 1857. --D. Gloria, a senhora era capaz de me dar um officio de homem. Quando o sacrist\u00e3o come\u00e7ou a distribuir as opas, entrou um sujeito esbaforido; era o meu rosto disse isto mesmo, porque tio Cosme, que era manifesta; os meus brinquedos foram sempre de egreja, e eu adorava os officios divinos. A prova n\u00e3o provava; todas as pessoas com quem.",
"order": 4,
"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/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
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
{
"next_order": 5
}
HTTP Request
GET api/v1/admin/how-it-works/additional-information
Export how it works
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
{
"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
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
null
HTTP Request
GET api/v1/admin/how-it-works/{how_it_works}
Permission required
how-it-works.show
Update how it works
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/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": "Dolor assumenda sint sed non minima.",
"text": "Ad est sequi consequatur et consectetur expedita. Nostrum aperiam consequuntur ea quidem. Rerum ab dolorum natus sunt illum dicta est. Dolorum autem doloremque voluptatibus qui et et.",
"order": 4,
"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/how-it-works/{how_it_works}
Permission required
how-it-works.edit
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
name | string | string|max:191 | |
text | string | nullable|string|max:10000 | |
order | integer | required|integer | |
is_active | boolean | boolean |
Remove how it works
Example request:
const axios = require('axios');
axios({
"method": "delete",
"url": "https://homologacao.clickweb.com.br:8445/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
Log
Get all logs
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
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
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
{
"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
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
null
HTTP Request
GET api/v1/admin/logs/{log}
Permission required
log.show
News
Get all news
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/news",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/admin/news
Permission required
news.list
Query Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
limit | integer | static(20) | 20 Max: 100 |
page | integer | integer | |
is_active | integer | integer | Available values: 0 1 |
orderBy | string | static(id:asc|created_at:asc) | id:asc .Available fields: id name author is_active created_at updated_at |
search | string | static(lorem) | in the fields: name author |
active/deactive news
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/news/active-deactive/{news}",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"uuid": "f1d7b106-dd82-3b6d-b49e-e55e76aaeafe",
"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/news/active-deactive/{news}
Permission required
news.edit
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
uuid | string | string | |
is_active | boolean | boolean |
Create news
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/news",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"capa": "{file}",
"title": "Ullam tempore temporibus nostrum.",
"link": "Delectus quia sapiente alias et minus sint.",
"button": "Provident recusandae fuga assumenda totam sapiente quia repellat.",
"text": "Ut quod unde est inventore voluptas. Eveniet ipsa modi vel similique. Eos fuga consequatur culpa est magni dolores dolorem quam.",
"scheduled_at": "2019-07-29T00:00:00-03:00",
"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/news
Permission required
news.create
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
capa | file | nullable|mimes:jpg,jpeg,png|max:4mb | |
title | string | required|string|max:191 | |
link | string | required|string|max:300 | |
button | string | required|string|max:191 | |
text | string | nullable|string|max:60000 | |
scheduled_at | string | string | ISO 8601 Y-m-d\TH:i:sP date |
is_active | boolean | boolean |
Autocomplete news
List a maximum of 50
items.
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/news/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
});
Example response:
null
HTTP Request
GET api/v1/admin/news/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 news
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/news/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
});
Example response:
{
"file_url": "{url}"
}
HTTP Request
GET api/v1/admin/news/export
Permission required
news.export
Query Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
date_start | string | static(2019-07-29T00:00:00-03:00) | 8601 Y-m-d\TH:i:sP |
date_end | string | static(2019-07-29T23:59:59-03:00) | 8601 Y-m-d\TH:i:sP |
Get news
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/news/{news}",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/admin/news/{news}
Permission required
news.show
Update news
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/news/{news}",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"capa": "{file}",
"capa_delete": "0af2c9cc-c16c-3583-932e-f290210aab3a",
"link": "Culpa excepturi quia et error et provident.",
"button": "Vitae non qui et et.",
"title": "Accusamus provident ut eaque natus possimus facilis doloremque.",
"text": "Cupiditate in rerum officia. Ducimus blanditiis rerum reprehenderit voluptatum qui recusandae quae nostrum. Ut vero deleniti voluptas omnis dolorem. Quas accusamus autem ullam nemo.",
"scheduled_at": "2019-07-29T00:00:00-03:00",
"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/news/{news}
Permission required
news.edit
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
capa | file | sometimes|nullable|mimes:jpg,jpeg,png|max:4mb | |
capa_delete | string | sometimes|nullable|string|max:191 | |
link | string | required|string|max:300 | |
button | string | required|string|max:191 | |
title | string | sometimes|nullable|string|max:191 | |
text | string | sometimes|nullable|string|max:60000 | |
scheduled_at | string | sometimes|nullable|string | ISO 8601 Y-m-d\TH:i:sP date |
is_active | boolean | sometimes|nullable|boolean |
Remove news
Example request:
const axios = require('axios');
axios({
"method": "delete",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/news/{news}",
"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/news/{news}
Permission required
news.delete
api/v1/admin/verify/news/slug
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/verify/news/slug",
"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/verify/news/slug
Get all news deleted
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/news-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
});
Example response:
null
HTTP Request
GET api/v1/admin/news-deleted
Permission required
news-deleted.list
Query Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
limit | integer | static(20) | 20 Max: 100 |
page | integer | integer | |
is_active | integer | integer | Available values: 0 1 |
orderBy | string | static(id:asc|created_at:asc) | id:asc .Available fields: id name author is_active created_at updated_at |
search | string | static(lorem) | in the fields: name author |
Export news deleted
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/news-deleted/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
});
Example response:
{
"file_url": "{url}"
}
HTTP Request
GET api/v1/admin/news-deleted/export
Permission required
news-deleted.export
Query Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
date_start | string | static(2019-07-29T00:00:00-03:00) | 8601 Y-m-d\TH:i:sP |
date_end | string | static(2019-07-29T23:59:59-03:00) | 8601 Y-m-d\TH:i:sP |
Get news deleted
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/news-deleted/{uuid}",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/admin/news-deleted/{uuid}
Permission required
news-deleted.show
Offers
Get all offers
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/offers",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/admin/offers
Permission required
offers.list
Query Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
limit | integer | integer | Default: 20 Max: 100 |
page | integer | integer | |
perfil_id | string | string|max:191 | |
customer_id | string | string|max:191 | |
category_id | string | string|max:191 | |
type | integer | integer | Available values: cupom oferta |
under_review | integer | integer | Available values: 0 1 |
is_active | integer | integer | Available values: 0 1 |
store_id | string | string|max:191 | |
orderBy | string | string | Default: id:asc .Available fields: id title price like shared comments created_at updated_at |
search | string | string | Search in the fields: uuid 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 |
Autocomplete stores
List a maximum of 50
items.
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/offers/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
});
Example response:
null
HTTP Request
GET api/v1/admin/offers/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 |
Create offer
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/offers",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"title": "Sint sunt sunt laboriosam necessitatibus.",
"store_id": "639828cc-4c7f-3c12-a88d-201fe1192c66",
"perfil_id[]": "20551aaf-6010-3aea-94cb-83798092eaa9",
"category_id[]": "1bb9b0d3-c2ff-37ca-aaa5-e6b651ebc6e9",
"link": "Ea voluptatem sunt est quibusdam corporis explicabo.",
"cupom": "Est officia rem necessitatibus id et assumenda quaerat.",
"tags[]": "43285ec7-a5e8-34f6-9612-441f82eb7b70",
"type": "'oferta'",
"discount_type": "'porcentagem'",
"price": "Omnis modi ex dolores culpa enim.",
"discount": "Dolor perspiciatis nihil reprehenderit est dolorum explicabo provident.",
"sku": "Sit voluptatibus illum in quia incidunt ut qui deserunt.",
"is_active": "1",
"destaque": "0",
"scheduled_at": "2019-07-29T23:59:59-03:00",
"images[]": "{file}",
"button_text": "d8658958-c454-3527-92ab-af5c1f870b30",
"color_primary": "7aea9c1e-c1b7-37f3-ab56-cefa4608a70a",
"color_secundary": "4766d706-332e-3ad8-98c6-cf67b2301831"
}
})
.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/offers
Permission required
offers.create
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
title | string | required|string|max:191 | |
store_id | string | required|string|max:191 | |
perfil_id[] | array | required|array|max:191 | |
category_id[] | array | required|array|max:191 | |
link | string | required|string|max:1500 | |
cupom | string | sometimes|nullable|string|max:191 | |
tags[] | array | required|array | |
type | string | required|string | Available values: cupom oferta |
discount_type | string | sometimes|nullable|string | Available values: numerico porcentagem |
price | numeric | sometimes|nullable|numeric|min:1 | |
discount | numeric | sometimes|nullable|numeric|min:1 | |
sku | numeric | required|numeric|min:1 | |
is_active | boolean | boolean | Default true |
destaque | boolean | boolean | Default true |
scheduled_at | string | nullable|string | ISO 8601 Y-m-d\TH:i:sP Future date |
images[] | file | nullable|array|mimes:jpg,jpeg,png|max:4mb | |
button_text | string | sometimes|nullable|string|max:191 | |
color_primary | string | sometimes|nullable|string|max:7 | |
color_secundary | string | sometimes|nullable|string|max:7 |
Export offers
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/offers/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
});
Example response:
{
"file_url": "{url}"
}
HTTP Request
GET api/v1/admin/offers/export
Permission required
offers.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 offer
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/offers/{offers}",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/admin/offers/{offers}
Permission required
offers.show
Edit offer
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/offers/update/{offers}",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"title": "Ut accusamus minus autem repudiandae eveniet et.",
"perfil_id[]": "d4cf4eca-c197-3c0d-a04e-ad6236c4fd4f",
"store_id": "ba2a0413-9677-3216-9d9e-b092ddbdb463",
"category_id[]": "af0758e7-f439-3008-ba6e-bb75b74aa529",
"link": "Laudantium perferendis sed qui cum nostrum est voluptatem.",
"cupom": "Dolorem voluptates odio dolor ea.",
"tags[]": "038f7967-9a0a-3d5d-af4a-d16d930aaf68",
"type": "'oferta'",
"discount_type": "'porcentagem'",
"price": "Natus laboriosam animi numquam cumque expedita.",
"discount": "Deserunt ut totam ad eaque tenetur.",
"sku": "Voluptas ipsam architecto qui.",
"is_active": "1",
"destaque": "0",
"scheduled_at": "2019-07-29T23:59:59-03:00",
"resend_notification": "1",
"under_review": "0",
"images": "{file}",
"imagens_no_delete[]": "da23887f-f11c-3fb2-9ba4-dfed819b1bb7",
"button_text": "fdc5226d-5e2d-3649-9de9-84bc9cf6d1a8",
"color_primary": "7aa6280d-bddb-34cf-9b83-45f7d6c79506",
"color_secundary": "a0f7fe18-d153-39a9-97fc-f69cc634763b"
}
})
.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/offers/update/{offers}
Permission required
offers.edit
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
title | string | sometimes|nullable|string|max:191 | |
perfil_id[] | array | sometimes|nullable|array|max:191 | |
store_id | string | sometimes|nullable|string|max:191 | |
category_id[] | array | sometimes|nullable|array|max:191 | |
link | string | sometimes|nullable|string|max:1500 | |
cupom | string | sometimes|nullable|string|max:191 | |
tags[] | array | required|array | |
type | string | sometimes|nullable|string | Available values: cupom oferta |
discount_type | string | sometimes|nullable|string | Available values: numerico porcentagem |
price | numeric | sometimes|nullable|numeric|min:1 | |
discount | numeric | sometimes|nullable|numeric|min:1 | |
sku | numeric | sometimes|nullable|numeric|min:1 | |
is_active | boolean | sometimes|nullable|boolean | Default true |
destaque | boolean | sometimes|nullable|boolean | Default true |
scheduled_at | string | nullable|string | ISO 8601 Y-m-d\TH:i:sP Future date |
resend_notification | boolean | sometimes|nullable|boolean | Default true |
under_review | boolean | sometimes|nullable|boolean | Default true |
images | file | sometimes|nullable|array|mimes:jpg,jpeg,png|max:4mb | |
imagens_no_delete[] | array | sometimes|nullable|array|max:191 | |
button_text | string | sometimes|nullable|string|max:191 | |
color_primary | string | sometimes|nullable|string|max:7 | |
color_secundary | string | sometimes|nullable|string|max:7 |
Remove Offer
Example request:
const axios = require('axios');
axios({
"method": "delete",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/offers/{offers}",
"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/offers/{offers}
Permission required
offers.delete
api/v1/admin/verify/offers/slug
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/verify/offers/slug",
"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/verify/offers/slug
Resend Notification
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/offers/resendalert",
"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/offers/resendalert
Get all offers deleted
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/offers-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
});
Example response:
null
HTTP Request
GET api/v1/admin/offers-deleted
Permission required
offers-deleted.list
Query Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
limit | integer | integer | Default: 20 Max: 100 |
page | integer | integer | |
perfil_id | string | string|max:191 | |
customer_id | string | string|max:191 | |
category_id | string | string|max:191 | |
is_active | integer | integer | Available values: 0 1 |
under_review | integer | integer | Available values: 0 1 |
store_id | string | string|max:191 | |
orderBy | string | string | Default: id:asc .Available fields: id title price like shared comments created_at updated_at |
search | string | string | Search in the fields: uuid 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 |
Export offers deleted
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/offers-deleted/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
});
Example response:
{
"file_url": "{url}"
}
HTTP Request
GET api/v1/admin/offers-deleted/export
Permission required
offers-deleted.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 offer deleted
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/offers-deleted/{uuid}",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/admin/offers-deleted/{uuid}
Permission required
offers-deleted.show
On Sales
Get all on sales
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/on-sales",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/admin/on-sales
Permission required
on-sales.list
Query Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
limit | integer | integer | Default: 20 Max: 100 |
page | integer | integer | |
offer_id | string | string|max:191 | |
is_active | integer | integer | Available values: 0 1 |
orderBy | string | string | Default: id:asc .Available fields: id phrase created_at updated_at |
search | string | string | Search in the fields: uuid phrase slug |
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 stores
List a maximum of 50
items.
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/on-sales/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
});
Example response:
null
HTTP Request
GET api/v1/admin/on-sales/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 |
Create on sale
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/on-sales",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"phrase": "Rerum officia quia commodi et inventore.",
"offer_id": "c991cd67-077f-3a2a-9873-81258541ec60",
"link": "Enim quo ut temporibus assumenda.",
"is_active": "0",
"start_at": "2019-07-29T23:59:59-03:00",
"end_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/on-sales
Permission required
on-sales.create
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
phrase | string | required|string|max:500 | |
offer_id | string | required|string|max:191 | |
link | string | required|string|max:191 | |
is_active | boolean | boolean | Default true |
start_at | string | nullable|string | ISO 8601 Y-m-d\TH:i:sP Future date |
end_at | string | nullable|string | ISO 8601 Y-m-d\TH:i:sP Future date |
Export on sales
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/on-sales/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
});
Example response:
{
"file_url": "{url}"
}
HTTP Request
GET api/v1/admin/on-sales/export
Permission required
on-sales.export
Query Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
limit | integer | integer | Default: 20 Max: 100 |
page | integer | integer | |
offer_id | string | string|max:191 | |
is_active | integer | integer | Available values: 0 1 |
orderBy | string | string | Default: id:asc .Available fields: id phrase created_at updated_at |
search | string | string | Search in the fields: uuid phrase slug |
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 on sale
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/on-sales/{onsale}",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/admin/on-sales/{onsale}
Permission required
offers.show
Edit on sale
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/on-sales/update/{onsale}",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"phrase": "Iusto consequatur rem quidem ipsam iure.",
"offer_id": "4b5f363b-6fe3-3211-984e-f0098dc0a939",
"link": "Voluptatum consequatur rerum modi minus molestias expedita perspiciatis.",
"is_active": "1",
"start_at": "2019-07-29T23:59:59-03:00",
"end_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/on-sales/update/{onsale}
Permission required
on-sales.edit
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
phrase | string | nullable|string|max:500 | |
offer_id | string | nullable|string|max:191 | |
link | string | nullable|string|max:191 | |
is_active | boolean | boolean | Default true |
start_at | string | nullable|string | ISO 8601 Y-m-d\TH:i:sP Future date |
end_at | string | nullable|string | ISO 8601 Y-m-d\TH:i:sP Future date |
Remove Offer
Example request:
const axios = require('axios');
axios({
"method": "delete",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/on-sales/{onsale}",
"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/on-sales/{onsale}
Permission required
on-sales.delete
OnBoarding
Get all onboardings
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
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
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/onboarding",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"frase": "Repellat adipisci id tenetur repellendus voluptatum.",
"frase2": "Repellat aut adipisci qui.",
"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
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,gif,avi,mov,webm,mpg,ogg,mkv,flv|max:8mb |
Get additional information
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
{
"next_order": 5
}
HTTP Request
GET api/v1/admin/onboarding/additional-information
Get onboarding
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
null
HTTP Request
GET api/v1/admin/onboarding/{onboarding}
Permission required
onboarding.show
Update onboarding
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/onboarding/{onboarding}",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"frase": "Quaerat facilis dolor repudiandae ipsum distinctio ut consequuntur.",
"frase2": "Pariatur dignissimos harum possimus error ut consequatur.",
"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/{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,gif,avi,mov,webm,mpg,ogg,mkv,flv|max:8mb |
Remove onboarding
Example request:
const axios = require('axios');
axios({
"method": "delete",
"url": "https://homologacao.clickweb.com.br:8445/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
Export onboarding
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/onboarding/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
});
Example response:
{
"file_url": "{url}"
}
HTTP Request
GET api/v1/admin/onboarding/export
Permission required
onboarding.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 |
Perfis
Get all perfil
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/perfis",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/admin/perfis
Permission required
perfis.list
Query Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
limit | integer | integer | Default: 20 Max: 100 |
page | integer | integer | |
is_active | integer | integer | Available values: 0 1 |
orderBy | string | string | Default: id:asc .Available fields: id name order created_at updated_at |
search | string | string | Search in the fields: uuid name |
active/deactive perfil
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/perfis/active-deactive/{perfis}",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"uuid": "e854e441-aef8-3512-a5b0-564c4d1d678a",
"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/perfis/active-deactive/{perfis}
Permission required
perfis.edit
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
uuid | string | string | |
is_active | boolean | boolean |
Autocomplete perfis
List a maximum of 50
items.
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/perfis/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
});
Example response:
null
HTTP Request
GET api/v1/admin/perfis/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 |
Create perfis
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/perfis",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"name": "Voluptatem et voluptate aut consectetur perspiciatis eum.",
"icon": "{file}",
"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/perfis
Permission required
perfis.create
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
name | string | required|string|max:191 | |
icon | file | nullable|mimes:jpg,jpeg,png|max:4mb | |
order | integer | required|integer | |
is_active | boolean | boolean | Default true |
Get additional information
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/perfis/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
});
Example response:
{
"next_order": 5
}
HTTP Request
GET api/v1/admin/perfis/additional-information
Export perfis
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/perfis/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
});
Example response:
{
"file_url": "{url}"
}
HTTP Request
GET api/v1/admin/perfis/export
Permission required
perfis.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 perfil
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/perfis/{perfis}",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/admin/perfis/{perfis}
Permission required
perfis.show
Update perfil
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/perfis/update/{perfis}",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"name": "Quibusdam quas voluptas velit voluptas velit saepe perferendis cupiditate.",
"icon_delete": "c9a4290d-63aa-3d46-935e-40bb4f5d9a00",
"icon": "{file}",
"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/perfis/update/{perfis}
Permission required
perfis.edit
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
name | string | sometimes|nullable|string|max:191 | |
icon_delete | string | required|string|max:191 | |
icon | file | nullable|mimes:jpg,jpeg,png|max:4mb | |
order | integer | sometimes|nullable|integer | |
is_active | boolean | sometimes|nullable|boolean |
Remove perfil
Example request:
const axios = require('axios');
axios({
"method": "delete",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/perfis/{perfis}",
"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/perfis/{perfis}
Permission required
perfis.delete
Permissions
Autocomplete permissions
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
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 |
Policy Cookies
Get privacy policy
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/policy-cookies",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/admin/policy-cookies
Permission required
privacy-policy.edit
Update privacy policy
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/policy-cookies",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"name": "Voluptatem natus id soluta culpa quas.",
"text": "Et eaque reprehenderit aliquam inventore. Possimus sint facere eius voluptate aut nihil quae."
}
})
.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/policy-cookies
Permission required
privacy-policy.edit
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
name | string | string|max:191 | |
text | string | nullable|string|max:60000 | HTML allowed |
Privacy Policy
Get privacy policy
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
null
HTTP Request
GET api/v1/admin/privacy-policy
Permission required
privacy-policy.edit
Update privacy policy
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/privacy-policy",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"name": "Sint aliquid at laudantium saepe laboriosam quod nobis.",
"text": "Earum aliquam quas est inventore. Maxime non blanditiis nam. Qui distinctio nihil quae sit sed laboriosam ipsa."
}
})
.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 |
Push City
Get all push
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
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
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/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": "Provident nihil placeat architecto.",
"body": "Excepturi assumenda quaerat ipsam suscipit dolores. A nobis quo quia cum delectus dolorem.",
"url": "http:\/\/www.galvao.com.br\/quo-facere-quia-error",
"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 |
Update push
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/push-city/{push}",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"uuid": "uuid",
"city_id": "2",
"title": "Sed suscipit itaque sit.",
"body": "Sit consequatur aut rem voluptatem. Nisi explicabo voluptas architecto ad expedita.",
"url": "https:\/\/correia.com.br\/quis-delectus-id-aliquid-animi.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-city/{push}
Permission required
push-city.edit
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
uuid | integer | required|string | |
city_id | integer | nullable|integer | City relationship |
title | string | nullable|string|max:50 | |
body | string | nullable|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
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
{
"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
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
null
HTTP Request
GET api/v1/admin/push-city/{push}
Permission required
push-city.show
Remove push
Example request:
const axios = require('axios');
axios({
"method": "delete",
"url": "https://homologacao.clickweb.com.br:8445/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
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
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
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/push-general",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"title": "Quos ut ut ratione ea.",
"body": "Est voluptatem consequuntur molestiae accusamus ut officiis. Voluptatibus saepe cumque a qui.",
"url": "http:\/\/bezerra.org\/",
"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 |
Update push
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/push-general/{push}",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"uuid": "uuid",
"title": "Consequatur sequi maiores vel consectetur.",
"body": "Dolorum aliquam porro iure at officia nemo. Nulla fugit voluptas nesciunt dicta.",
"url": "http:\/\/darosa.net.br\/aut-maxime-pariatur-fuga-consequatur-est-aut-voluptatem.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-general/{push}
Permission required
push-general.edit
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
uuid | integer | required|string | |
title | string | nullable|string|max:50 | |
body | string | nullable|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
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
{
"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
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
null
HTTP Request
GET api/v1/admin/push-general/{push}
Permission required
push-general.show
Remove push
Example request:
const axios = require('axios');
axios({
"method": "delete",
"url": "https://homologacao.clickweb.com.br:8445/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
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
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
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/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": "Et quo natus earum non natus non distinctio.",
"body": "Omnis sint exercitationem facilis. Nobis est vel voluptatum quo eaque. Iure corporis quis odit et.",
"url": "http:\/\/dasdores.org\/dolorem-nobis-voluptas-dolor-distinctio-delectus-doloribus.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 |
Update push
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/push-state/{push}",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"uuid": "uuid",
"state_id": "2",
"title": "Ratione ducimus aperiam commodi dolor.",
"body": "Totam tempore rerum numquam magni explicabo. Incidunt molestias facere illo quia enim.",
"url": "http:\/\/www.avila.net\/dicta-exercitationem-et-voluptate-laboriosam-explicabo-molestias-aut",
"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/{push}
Permission required
push-state.edit
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
uuid | integer | required|string | |
state_id | integer | nullable|integer | State relationship |
title | string | nullable|string|max:50 | |
body | string | nullable|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
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
{
"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
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
null
HTTP Request
GET api/v1/admin/push-state/{push}
Permission required
push-state.show
Remove push
Example request:
const axios = require('axios');
axios({
"method": "delete",
"url": "https://homologacao.clickweb.com.br:8445/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
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
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 | |
user_id | string | uuid | Customer user relationship |
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
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/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": "b7b9aa72-d364-3bf4-8942-b0adf9d4da08",
"title": "Tempore voluptas et molestiae similique vitae.",
"body": "Eos explicabo ut ducimus non voluptatibus rem rerum. Accusantium iure ad impedit omnis.",
"url": "https:\/\/www.aranda.org\/reprehenderit-dolor-iste-tenetur-error-sapiente-dolor-aut",
"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 |
Update push
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/push-user/{push}",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"uuid": "uuid",
"user_id": "e67ea225-c986-31fc-8310-e28c2681c4b7",
"title": "Vel modi iusto sunt assumenda magnam sunt cumque.",
"body": "Provident qui dicta et sint nobis voluptas. Magnam sequi illum nulla est eos quidem.",
"url": "https:\/\/serra.com.br\/voluptatem-aut-rem-atque.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/{push}
Permission required
push-user.edit
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
uuid | integer | required|string | |
user_id | integer | nullable|uuid | Customer user relationship |
title | string | nullable|string|max:50 | |
body | string | nullable|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
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
{
"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
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
null
HTTP Request
GET api/v1/admin/push-user/{push}
Permission required
push-user.show
Remove push
Example request:
const axios = require('axios');
axios({
"method": "delete",
"url": "https://homologacao.clickweb.com.br:8445/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
Reports
Get all reports error
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/reports/error",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/admin/reports/error
Permission required
reports-error.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 title 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 |
Export report error
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/reports/error/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
});
Example response:
{
"file_url": "{url}"
}
HTTP Request
GET api/v1/admin/reports/error/export
Permission required
reports-error.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 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 |
Get report error
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/reports/error/{reportError}",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/admin/reports/error/{reportError}
Permission required
reports-error.show
Remove report error
Example request:
const axios = require('axios');
axios({
"method": "delete",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/reports/error/{reportError}",
"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/reports/error/{reportError}
Permission required
reports-error.delete
Get all reports finish
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/reports/finish",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/admin/reports/finish
Permission required
reports-finish.list
Query Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
limit | integer | integer | Default: 20 Max: 100 |
page | integer | integer | |
perfil_id | string | string|max:191 | |
category_id | string | string|max:191 | |
is_active | integer | integer | Available values: 0 1 |
under_review | integer | integer | Available values: 0 1 |
is_internacional | integer | integer | Available values: 0 1 |
store_id | string | string|max:191 | |
orderBy | string | string | Default: id:asc .Available fields: id title price like shared comments created_at updated_at |
search | string | string | Search in the fields: uuid 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 |
Export report finish
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/reports/finish/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
});
Example response:
{
"file_url": "{url}"
}
HTTP Request
GET api/v1/admin/reports/finish/export
Permission required
reports-finish.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 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 |
Get report offer finish
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/reports/finish/{offer}",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/admin/reports/finish/{offer}
Permission required
reports-finish.show
Remove report offer finish
Example request:
const axios = require('axios');
axios({
"method": "delete",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/reports/finish/{offer}",
"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/reports/finish/{offer}
Permission required
reports-finish.delete
Rich Text Editor
Upload image
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
{
"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
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
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
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/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": "Distinctio quia ipsam nesciunt ea. Earum voluptatibus aut nobis amet consectetur.",
"permissions[0]": "78648d36-55d2-350b-b755-1a66a2252161"
}
})
.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 | Description |
---|---|---|---|
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
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
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
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
{
"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
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
null
HTTP Request
GET api/v1/admin/roles/{role}
Permission required
roles.show
Update role
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/roles/{role}",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"name": "Non et asperiores velit molestiae.",
"description": "Non magni consequatur quas occaecati unde quaerat. Impedit alias pariatur corrupti eius qui.",
"permissions[0]": "f8211f5c-bbbc-33d9-bee3-43f883f22777"
}
})
.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 | Description |
---|---|---|---|
name | string | string|max:50 | |
description | string | required|string|max:100 | |
permissions[] | array | array|min:1 | |
permissions[0] | uuid | required|uuid |
Remove role
Example request:
const axios = require('axios');
axios({
"method": "delete",
"url": "https://homologacao.clickweb.com.br:8445/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
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
null
HTTP Request
GET api/v1/admin/settings/general
Permission required
settings-general.list
Update settings
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/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",
"whatsapp_group": "Rerum perspiciatis atque facere sed explicabo.",
"telegram_group": "Quia est in et minus labore ut.",
"show_whatsapp": "1",
"facebook": "Qui iure et dolor aliquid.",
"instagram": "At ab et voluptatem sit.",
"telegram": "Aut eum dolorum quo iusto.",
"url_site": "Voluptate optio aut dolores vitae error placeat amet.",
"whatsapp_number": "(45) 98582-7347"
}
})
.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 | Description |
---|---|---|---|
app_url_android | string | nullable|string|url | |
app_url_ios | string | nullable|string|url | |
whatsapp_group | string | nullable|string|url | |
telegram_group | string | nullable|string|url | |
show_whatsapp | string | nullable|boolean | |
string | nullable|string|url | ||
string | nullable|string|url | ||
telegram | string | nullable|string|url | |
url_site | string | nullable|string|url | |
whatsapp_number | integer | required|string|phone | Format (99) 9999-9999 OR (99) 99999-9999 |
Settings Notifications
Get settings
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
null
HTTP Request
GET api/v1/admin/settings/notifications
Permission required
settings-notifications.list
Update settings
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/settings/notifications",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"delete_account[0]": "nadia49@example.com",
"create_account[0]": "ftamoio@example.net",
"denunciation_comment[0]": "nayara55@example.net",
"offer_error[0]": "artur.solano@example.com",
"offer_finish[0]": "xquintana@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 |
---|---|---|---|
delete_account[] | array | array|min:1 | |
delete_account[0] | string | required|email | |
create_account[] | array | array|min:1 | |
create_account[0] | string | required|email | |
denunciation_comment[] | array | array|min:1 | |
denunciation_comment[0] | string | required|email | |
offer_error[] | array | array|min:1 | |
offer_error[0] | string | required|email | |
offer_finish[] | array | array|min:1 | |
offer_finish[0] | string | required|email |
Stores
Get all stores
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/stores",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/admin/stores
Permission required
stores.list
Query Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
limit | integer | integer | Default: 20 Max: 100 |
page | integer | integer | |
is_active | integer | integer | Available values: 0 1 |
orderBy | string | string | Default: id:asc .Available fields: id name order created_at updated_at |
search | string | string | Search in the fields: uuid name |
Autocomplete stores
List a maximum of 50
items.
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/stores/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
});
Example response:
null
HTTP Request
GET api/v1/admin/stores/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 |
Create stores
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/stores",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"name": "Unde enim ut voluptatem dicta animi itaque aut.",
"image": "{file}",
"order": 7,
"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/stores
Permission required
stores.create
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
name | string | required|string|max:191 | |
image | file | nullable|mimes:jpg,jpeg,png|max:4mb | |
order | integer | required|integer | |
is_active | boolean | boolean | Default true |
Get additional information
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/stores/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
});
Example response:
{
"next_order": 5
}
HTTP Request
GET api/v1/admin/stores/additional-information
Export stores
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/stores/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
});
Example response:
{
"file_url": "{url}"
}
HTTP Request
GET api/v1/admin/stores/export
Permission required
stores.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 store
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/stores/{stores}",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/admin/stores/{stores}
Permission required
stores.show
Update perfil
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/stores/update/{stores}",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"name": "Quisquam animi harum repellendus sunt.",
"image": "{file}",
"order": 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/stores/update/{stores}
Permission required
stores.edit
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
name | string | sometimes|nullable|string|max:191 | |
image | file | nullable|mimes:jpg,jpeg,png|max:4mb | |
order | integer | sometimes|nullable|integer | |
is_active | boolean | sometimes|nullable|boolean |
Remove store
Example request:
const axios = require('axios');
axios({
"method": "delete",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/stores/{stores}",
"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/stores/{stores}
Permission required
stores.delete
Get all stores deleted
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/stores-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
});
Example response:
null
HTTP Request
GET api/v1/admin/stores-deleted
Permission required
stores-deleted.list
Query Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
limit | integer | integer | Default: 20 Max: 100 |
page | integer | integer | |
is_active | integer | integer | Available values: 0 1 |
orderBy | string | string | Default: id:asc .Available fields: id name order created_at updated_at |
search | string | string | Search in the fields: uuid name |
Export stores deleted
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/stores-deleted/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
});
Example response:
{
"file_url": "{url}"
}
HTTP Request
GET api/v1/admin/stores-deleted/export
Permission required
stores-deleted.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 store deleted
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/stores-deleted/{uuid}",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/admin/stores-deleted/{uuid}
Permission required
stores-deleted.show
Stories
Get all stories
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/stories",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/admin/stories
Permission required
story.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 phrase order active |
search | string | string | Search in the fields: phrase |
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 story
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/stories",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"phrase": "Neque nihil ut et placeat repudiandae tempore.",
"groups_stories_id": "e1741ce8-8cfe-3e93-b165-d26a7a5f66d7",
"midia": "{file}",
"order": 2,
"link": "Ut aperiam adipisci ut et et.",
"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/stories
Permission required
story.create
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
phrase | string | required|string|max:191 | |
groups_stories_id | string | required|string|max:191 | |
midia | file | required|file|mimes:png,jpg,jpeg,gif,flv,mp4,m3u8,ts,3gp,mov,avi,wmv,video/x-flv,video/mp4,application/x-mpegURL,video/MP2T,video/3gpp,video/quicktime,video/x-msvideo,video/x-ms-wmv | |
order | integer | nullable|integer | |
link | string | nullable|string|max:191 | |
is_active | boolean | nullable|boolean |
Get additional information.
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/stories/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
});
Example response:
{
"next_order": 5
}
HTTP Request
GET api/v1/admin/stories/additional-information
get story
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/stories/{story}",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/admin/stories/{story}
Permission required
story.show
Update story
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/stories/{story}",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"phrase": "In explicabo occaecati quia voluptatem aut reprehenderit vitae libero.",
"groups_stories_id": "4068d5c4-c91f-3876-89dc-572a5cf580c0",
"midia": "{file}",
"order": 2,
"link": "Repellat blanditiis ducimus id quo voluptatem.",
"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/stories/{story}
Permission required
story.edit
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
phrase | string | sometimes|nullable|string|max:191 | |
groups_stories_id | string | required|string|max:191 | |
midia | file | sometimes|nullable|file|mimes:png,jpg,jpeg,gif,flv,mp4,m3u8,ts,3gp,mov,avi,wmv,video/x-flv,video/mp4,application/x-mpegURL,video/MP2T,video/3gpp,video/quicktime,video/x-msvideo,video/x-ms-wmv | |
order | integer | nullable|integer | |
link | string | nullable|string|max:191 | |
is_active | boolean | sometimes|nullable|boolean |
Delete story
Example request:
const axios = require('axios');
axios({
"method": "delete",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/stories/{story}",
"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/stories/{story}
Permission required
story.delete
Export onboarding
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/stories/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
});
Example response:
{
"file_url": "{url}"
}
HTTP Request
GET api/v1/admin/stories/export
Permission required
onboarding.export
Query Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
date_start | string | static(2019-07-29T00:00:00-03:00) | 8601 Y-m-d\TH:i:sP |
date_end | string | static(2019-07-29T23:59:59-03:00) | 8601 Y-m-d\TH:i:sP |
System Log
Get all logs
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
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
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
{
"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
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
null
HTTP Request
GET api/v1/admin/system-log/{log}
Permission required
system-log.show
Tags
Get all tag
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/tags",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/admin/tags
Permission required
tags.list
Query Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
limit | integer | integer | Default: 20 Max: 100 |
page | integer | integer | |
is_active | integer | integer | Available values: 0 1 |
orderBy | string | string | Default: id:asc .Available fields: id name order created_at updated_at |
search | string | string | Search in the fields: uuid name |
active/deactive tag
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/tags/active-deactive/{tags}",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"uuid": "f7b0b778-c838-388c-a517-0053bca07e52",
"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/tags/active-deactive/{tags}
Permission required
tags.edit
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
uuid | string | string | |
is_active | boolean | boolean |
Autocomplete Tags
List a maximum of 50
items.
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/tags/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
});
Example response:
null
HTTP Request
GET api/v1/admin/tags/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 |
Create Tags
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/tags",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"name": "Sapiente voluptatum eligendi nesciunt.",
"color": "Ab et tempore id ratione velit nemo quos dolores.",
"background_color": "Accusantium odit illo possimus nisi sint quia sunt est.",
"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/tags
Permission required
tags.create
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
name | string | required|string|max:191 | |
color | string | sometimes|nullable|string|max:191 | |
background_color | string | sometimes|nullable|string|max:191 | |
is_active | boolean | boolean | Default true |
Export Tags
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/tags/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
});
Example response:
{
"file_url": "{url}"
}
HTTP Request
GET api/v1/admin/tags/export
Permission required
tags.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 tag
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/tags/{tags}",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/admin/tags/{tags}
Permission required
tags.show
Update tag
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/tags/update/{tags}",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"name": "Omnis qui quis sint soluta impedit.",
"color": "Maiores nesciunt sint quibusdam.",
"background_color": "Nam aut dolores dolores minus qui.",
"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/tags/update/{tags}
Permission required
tags.edit
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
name | string | sometimes|nullable|string|max:191 | |
color | string | sometimes|nullable|string|max:191 | |
background_color | string | sometimes|nullable|string|max:191 | |
is_active | boolean | sometimes|nullable|boolean |
Remove tag
Example request:
const axios = require('axios');
axios({
"method": "delete",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/tags/{tags}",
"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/tags/{tags}
Permission required
tags.delete
Terms Of Use
Get terms of use
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
null
HTTP Request
GET api/v1/admin/terms-of-use
Permission required
terms-of-use.edit
Update terms of use
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/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": "Dignissimos corrupti quaerat commodi.",
"text": "Aperiam distinctio a impedit dolor deserunt. Eos et fuga autem iste. Vero magnam consequatur quia qui nostrum voluptatem et occaecati. Autem fugiat ullam dolores culpa."
}
})
.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
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
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
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/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": "Saulo Renan Tamoio",
"password_random": "1",
"password": "123456",
"password_confirmation": "123456",
"email": "regiane94@example.com",
"is_active": "0",
"roles[0]": "7e03aeaf-a7e6-3432-a142-ca80a605fac9"
}
})
.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 |
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.
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
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
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
{
"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
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
null
HTTP Request
GET api/v1/admin/users/{user}
Permission required
users.show
Update user
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/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": "0",
"roles[0]": "8317a757-917f-346c-a45a-71f4dc476cf0"
}
})
.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 | Description |
---|---|---|---|
is_active | boolean | boolean | |
roles[] | array | array|min:1 | |
roles[0] | uuid | required|uuid |
Remove user
Example request:
const axios = require('axios');
axios({
"method": "delete",
"url": "https://homologacao.clickweb.com.br:8445/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.
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
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
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
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
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/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
});
Example response:
null
HTTP Request
GET api/v1/admin/webservice/zipcode/{zipcode}