NAV
javascript

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": "Natus culpa illum consectetur et.",
        "file": "{file}",
        "file_mobile": "{file}",
        "video": "Ipsa delectus esse odio possimus corrupti.",
        "text": "Quod sed rem dolore labore aut ducimus. Et molestiae hic inventore voluptatem earum laudantium. Adipisci maiores ea natus cumque at voluptas id."
}
})
.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": "Et molestiae sunt recusandae aut quos.",
        "file": "{file}",
        "file_mobile": "{file}",
        "video": "Molestias sunt ea saepe nisi.",
        "text": "Magnam consequatur assumenda fugit quaerat. Ea impedit quisquam fugit quo. Quasi dolor et id dolores recusandae."
}
})
.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": "vroque@example.net",
        "password": "Wvzb0qp0B8",
        "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
email string required|email
password string required|string|min:6
token_name string required|string|max:191 Client app name

Password recovery

Send password reset link do user

Example request:

const axios = require('axios');

axios({
    "method": "post",
    "url": "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": "paula.molina@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
email 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": "661d6362-3970-3778-997d-ca1f24d9cb05",
        "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/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": "Non consequatur et iusto delectus.",
        "order": 11,
        "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

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": "Cum veniam veniam quisquam sit.",
        "order": 9,
        "is_active": "0"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/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": "nHZvoJsHMQ",
        "password_confirmation": "my_new_password",
        "name": "Voluptas voluptatem molestiae molestiae sit.",
        "email": "mares.esther@example.org",
        "is_active": "0",
        "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
email email 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": "nths0I8Cga",
        "password_confirmation": "my_new_password",
        "name": "Placeat perspiciatis labore qui labore et incidunt accusamus ut.",
        "email": "sandoval.catarina@example.com",
        "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
email email 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": "c7b81d25-6f93-3521-a522-949f8df00664",
        "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": "d84d8282-fd43-3027-b2af-25fdc2bc1c53",
        "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": "b3d0eb8f-d915-3c94-becd-d557a054a23d",
        "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": "Voluptatum est et voluptas illum dolor ut.",
        "text": "Como v\u00eas, Capit\u00fa, aos quatorze annos, tinha j\u00e1 ideias atrevidas, muito menos que duvidoso em que fui concebido. Tendo-lhe nascido morto o primeiro filho, minha m\u00e3e queria ter uma senhora intima ao p\u00e9 do po\u00e7o, como se n\u00e3o tiver outro d'aqui at\u00e9 ao fim do outro capitulo foi obra de maior formalidade, actos publicos, cartas de cerimonia, etc., se empregue o titulo inteiro: protonotario apostolico. Esta distinc\u00e7\u00e3o do papa dera-lhe grande contentamento e a besta partia a trote. Tambem n\u00e3o se d\u00ea por achado... Hoje de tarde falou como voc\u00ea n\u00e3o imagina. --Mas falou \u00e1 toa? perguntei, a ver se mam\u00e3e pedisse a Deus por mim, voltou e, abafando a voz, disse que o preto foi cantando, o pr\u00e9g\u00e3o das velhas tardes, t\u00e3o sabido do bairro e da defesa, n\u00e3o perdiamos a cautela necessaria para n\u00e3o sair padre? Padre Cabral retorquia: --A voca\u00e7\u00e3o \u00e9 tudo. O que eu digo \u00e9 outra cousa. A certos respeitos, aquella vida antiga apparece-me despida de muitos encantos que lhe ficassem bem esticadas. A gravata de setim preto, com um creado. A casa era a golodice do padre e do meu namoro com a palavra o que queria dizer, respondia affirmativamente, e ia talvez contar \u00e1s outras. Novamente me recommendou que n\u00e3o pude miral-o por muito tempo, disse elle a um mascate italiano, moldura tosca, argolinha de lat\u00e3o, pendente da parede, entre as duas trancas. N\u00e3o as fiz logo, nem assim depressa, como podem supp\u00f4r os cabelleireiros de officio, mas devagar, devagarinho, saboreando pelo tacto aquelles fios grossos, que eram levemente grossas ou finas, conforme o sexo dos interlocutores, e reproduziam com modera\u00e7\u00e3o a ternura e a minha alma; era ao meu quarto, peguei dos livros e corri \u00e1 porta e falar no corredor. Era o momento n\u00e3o \u00e9 para mim. Capit\u00fa derreou a cabe\u00e7a, e fic\u00e1mos a olhar para mim, \u00abjoven seminarista\u00bb, a quem eu perdoava tudo, o mal que minha m\u00e3e dizia que com o nosso Bentinho no seminario? \u00c9 mais que a lettra, destinada a picar a vaidade das crian\u00e7as, foi que a sua felicidade, que eu n\u00e3o tenho.",
        "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/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": "Ipsam libero quod qui sint.",
        "text": "Saepe deleniti hic blanditiis doloribus repellat at minima ut. Dolore cupiditate magnam enim quaerat totam velit. Omnis earum inventore perspiciatis quaerat possimus saepe enim saepe.",
        "order": 11,
        "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": "Laborum et nobis ab provident quasi.",
        "order": 1,
        "icon": "{file}",
        "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

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": "Nisi distinctio provident sit distinctio.",
        "text": "Voluptatem temporibus ut illo. Consequuntur atque veniam qui quia. Consequatur unde nostrum iure est qui.",
        "icon": "{file}",
        "order": 3,
        "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": "Sit qui ab ut perferendis consequatur.",
        "text": "Fiquei serio depressa. Era o pae era o mesmo no ch\u00e3o, e pedi-lhe a taquara. N\u00e3o me atrevi a dizer tudo a todos. Cerrava os dentes, os olhos, toda a verdade, mas com agua do po\u00e7o e lavadouro. Uso lou\u00e7a velha e mobilia velha. Emfim, agora, como outr'ora, ha aqui o mesmo aspecto e economia daquella outra, que desappareceu. Constructor e pintor entenderam bem as indica\u00e7\u00f5es que lhes fiz: \u00e9 o imperador! \u00e9 o que melhor se entenda aquella manh\u00e3 da minha alma. Todas essas cousas e outras confidencias. A emo\u00e7\u00e3o era doce e mystica daquelles outros condiscipulos fosse aborrecivel ao seu genio essencialmente tragico. Tramou uma rebelli\u00e3o que foi descoberta a tempo, e elle expulso do conservatorio. Tudo se teria passado sem mais nada, e para mim, como alma perdida, ou pegava-me na m\u00e3o, e poz o dedo na bocca. Uma preta, que veiu de dentro accender o lampi\u00e3o do corredor, vendo-nos naquella attitude, quasi \u00e1s escuras, riu de sympathia e murmurou em tom que ouvissemos alguma cousa contraria \u00e1 morte, e n\u00e3o durmo mal. Ora, como tudo can\u00e7a, esta monotonia acabou por exhaurir-me tambem. Quiz variar, e lembrou-me escrever um livro. Jurisprudencia, philosophia e politica acudiram-me, mas n\u00e3o passei a sala da lic\u00e7\u00e3o; sentei-me na cama, recordando o penteado e o outro atraz, e fugiu com o padre Cabral, pela autoridade, mas o que era. Jos\u00e9 Dias, tenho visto os pequenos brincando, e nunca vi nada que fa\u00e7a desconfiar. Basta a edade; Bentinho mal tem quinze annos. Capit\u00fa fez um gesto de adeus, dizendo ainda: \u00abA medicina, a nossa Escola. Fa\u00e7a isso por mim, e me atirasse a ella com mil palavras callidas e mimosas... N\u00e3o mofes dos meus estudos. --Estamos a bordo, Bentinho, estamos a bordo! XXVII Ao port\u00e3o. Ao port\u00e3o do Passeio, um mendigo estendeu-nos a m\u00e3o. Jos\u00e9 Dias alvoro\u00e7ara-me, a lic\u00e7\u00e3o do _Cantico_, n\u00e3o me appareceu. N\u00e3o deixou minha m\u00e3e, e tambem porque \u00e9 que acontecia? Tinha estudado no seminario e suas consequencias, e, ali\u00e1s, decorou o principal, isto \u00e9, que a n\u00e3o ser nascido. Depois da.",
        "order": 11,
        "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": "A cupiditate ipsa facere est.",
        "text": "Laborum et sit reiciendis illo. Non a voluptatem quia magnam similique aut ea saepe. Voluptatem numquam iusto vel. Iste aut impedit fuga illum fugit.",
        "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": "ac69e49f-d02d-308e-bb41-c991a80416de",
        "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/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": "Animi aut inventore eos fuga.",
        "link": "Ipsum rem labore veniam saepe quidem.",
        "button": "Soluta quos fugit qui molestiae.",
        "text": "Molestias saepe tenetur facilis dolorem qui. Impedit ut tempore necessitatibus assumenda quaerat amet dolor quia. Praesentium aperiam mollitia aut ut iure placeat esse facere.",
        "scheduled_at": "2019-07-29T00:00:00-03:00",
        "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

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": "bbe96f55-c723-392c-a6db-dbf9af284726",
        "link": "Id pariatur ab itaque maiores deserunt quia illum.",
        "button": "Ut beatae est ipsa delectus.",
        "title": "Natus aut suscipit voluptas.",
        "text": "Ea nulla qui pariatur assumenda. Id et perferendis quia doloribus quam. Veritatis nostrum ut accusamus molestias cumque ut voluptatem.",
        "scheduled_at": "2019-07-29T00:00:00-03:00",
        "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/{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": "Laborum ea molestiae quia quas nesciunt.",
        "store_id": "b11ef388-b81c-3fa0-be7a-10de00348203",
        "perfil_id[]": "dda68f8e-edcf-3377-90b5-e26e22b2da97",
        "category_id[]": "fed827da-c7d3-31fb-be2b-94c38f52a407",
        "link": "Ex et expedita facilis aut tempora eaque hic et.",
        "cupom": "Sequi dolor ut dolor ad sunt ad.",
        "tags[]": "5fe99cf8-e263-3909-a5b3-6e47cc8d26a3",
        "type": "'oferta'",
        "discount_type": "'porcentagem'",
        "price": "Facere praesentium laboriosam dolor totam.",
        "discount": "Aliquam qui labore sunt animi qui dolorem consectetur.",
        "sku": "Maxime placeat consequuntur quibusdam odio aut minima tempore.",
        "is_active": "1",
        "destaque": "0",
        "scheduled_at": "2019-07-29T23:59:59-03:00",
        "images[]": "{file}",
        "button_text": "e41e0af0-d79d-36e2-ad5f-e193958d6668",
        "color_primary": "fdb68e65-7e86-33f3-9285-56e47b4e0966",
        "color_secundary": "f3f98c48-42af-3fc8-9eb4-12db941eacf0"
}
})
.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": "In quo rerum esse sunt.",
        "perfil_id[]": "4e710277-8257-33f1-9ae1-b70211b5f285",
        "store_id": "048a1347-2a07-3212-a1f2-c4d3f1d90857",
        "category_id[]": "f8a04e76-2a55-3c85-a69d-ad59be3324de",
        "link": "Atque occaecati ea error dolor ut.",
        "cupom": "Dolore corporis dolor quod numquam in dicta velit.",
        "tags[]": "b7f167a6-7b76-3d98-8088-868776f5af9a",
        "type": "'oferta'",
        "discount_type": "'porcentagem'",
        "price": "Et et quaerat accusamus at.",
        "discount": "Accusantium est praesentium et aut vero maxime.",
        "sku": "Dolor rerum repudiandae ut vel.",
        "is_active": "0",
        "destaque": "0",
        "scheduled_at": "2019-07-29T23:59:59-03:00",
        "resend_notification": "0",
        "under_review": "0",
        "images": "{file}",
        "imagens_no_delete[]": "36a63c5f-e7d4-3a69-9dfd-2e3337147539",
        "button_text": "0ab6131a-6622-30fa-bfe3-4ab802f27d0c",
        "color_primary": "4b02d676-7ea9-3e74-9648-90221898289f",
        "color_secundary": "82d176bb-b5a4-3de8-bd66-9b30f5e4b91d"
}
})
.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": "Velit ut repudiandae vel aut et.",
        "offer_id": "5c4b4423-39c7-38cc-b3d1-4eafd5dea8dc",
        "link": "Totam autem est consequuntur sint repellat illum.",
        "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

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": "Ipsam amet aspernatur sit aut perferendis temporibus blanditiis.",
        "offer_id": "b14356b7-5e44-3c94-8802-f56c07d257d8",
        "link": "Quam id soluta nihil unde dolore distinctio aspernatur.",
        "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": "Consequatur sed expedita saepe.",
        "frase2": "Qui odit qui et debitis laborum vel molestiae.",
        "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": "Enim fugit nemo vel consequuntur.",
        "frase2": "Consequuntur quia velit ab exercitationem ipsum ut.",
        "ordem": "1",
        "is_active": "1",
        "file": "{file}"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/onboarding/{onboarding}

Permission required

onboarding.edit

Parameters

Parameter Type Validation Description
frase string nullable|string|max:191
frase2 string nullable|string|max:191
ordem integer nullable|integer
is_active boolean nullable|boolean Default true
file file mimes:jpg,jpeg,png,mp4,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": "d1a61661-7045-32cf-958c-1fc102910cf3",
        "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": "Assumenda et quisquam dolor quia.",
        "icon": "{file}",
        "order": 3,
        "is_active": "0"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/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": "Fugiat molestiae ut aut optio illo maxime est.",
        "icon_delete": "7be22b1b-184e-3ffb-8be7-e698ab191b80",
        "icon": "{file}",
        "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/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": "Blanditiis ullam quas ex laudantium.",
        "text": "Corrupti ut fugit sint nam consectetur mollitia. Exercitationem voluptas non aut. Labore occaecati qui recusandae ea suscipit. Ea est repellat facilis ut."
}
})
.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": "Repudiandae ut quasi non est laborum voluptatem dolores.",
        "text": "Ratione sequi qui consequatur iste. Ea natus veniam sint sint odio rerum nihil. Inventore omnis et saepe molestias mollitia ipsa ipsa. Adipisci magnam et a corrupti quos."
}
})
.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": "Itaque pariatur quae veniam libero.",
        "body": "Eum magnam dolore laboriosam. In ut quia amet. In consequuntur nihil pariatur est molestiae.",
        "url": "http:\/\/www.estrada.br\/illum-eligendi-provident-dolore-et-consequatur-ipsam-eos",
        "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": "Quo odit illo aut.",
        "body": "Aut omnis soluta ipsam quis animi. Porro ipsa ipsum non quod.",
        "url": "http:\/\/medina.com\/aperiam-aut-ipsam-velit.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": "Nostrum nesciunt eum consequatur.",
        "body": "Dignissimos itaque animi deserunt labore sit. Qui quia sit voluptatem voluptas qui placeat.",
        "url": "http:\/\/www.paes.net\/porro-aut-alias-soluta-aut-beatae",
        "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": "Beatae dolor et aut velit.",
        "body": "Ea deleniti dicta tempore aliquam est et suscipit. Ullam voluptatem numquam autem nesciunt.",
        "url": "https:\/\/www.medina.com\/minima-sapiente-sunt-quisquam-expedita-cum-quos-sint-deleniti",
        "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": "Ut aut id sit.",
        "body": "Inventore et cum voluptatem. Ut provident nisi exercitationem qui.",
        "url": "https:\/\/www.mendonca.com.br\/voluptates-possimus-ab-aspernatur-placeat-velit-est-vel",
        "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": "Est cumque qui qui.",
        "body": "Explicabo unde sunt ut fuga. Odit nam enim est possimus. Iusto debitis consequatur ipsam maxime.",
        "url": "http:\/\/cortes.com.br\/ad-et-eos-adipisci-deleniti-consequatur-error-omnis",
        "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": "c89985a1-c801-3770-99b8-b64d001d7541",
        "title": "Odio ut maxime labore rerum quisquam.",
        "body": "Rem enim molestiae et repellat nisi quaerat id. Minima minima et rerum consequatur ut magnam.",
        "url": "http:\/\/www.medina.com\/",
        "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": "2c73cb20-80f8-34c8-81c9-1cb2140560a7",
        "title": "Cupiditate illum enim rerum repellendus.",
        "body": "Harum et eveniet perspiciatis laboriosam explicabo alias cupiditate. Et deserunt porro natus.",
        "url": "http:\/\/rezende.net\/",
        "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": "Qui ratione qui dolor nihil aut. Velit eligendi sed suscipit a hic mollitia. Vero ut a explicabo.",
        "permissions[0]": "5b4ece85-3c40-37ce-b60e-0b0600707c65"
}
})
.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": "Perferendis odit et nisi ipsa at et.",
        "description": "Et doloribus aut ut alias. Numquam voluptas minima recusandae et dignissimos.",
        "permissions[0]": "4081edb8-d97c-3313-9cae-00f79050c029"
}
})
.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": "Ad sit voluptatem molestiae in.",
        "telegram_group": "Cumque aperiam et incidunt delectus enim earum dolor.",
        "show_whatsapp": "1",
        "facebook": "Unde sed expedita magnam qui.",
        "instagram": "Dolorem sit blanditiis tenetur id consequatur assumenda dolorem vitae.",
        "telegram": "Nesciunt minus facilis itaque.",
        "url_site": "Optio non perspiciatis aut ut sed sed qui.",
        "whatsapp_number": "(42) 97813-1127"
}
})
.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
facebook string nullable|string|url
instagram 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]": "pvalente@example.net",
        "create_account[0]": "maldonado.malu@example.net",
        "denunciation_comment[0]": "campos.adriel@example.net",
        "offer_error[0]": "vinicius.gil@example.org",
        "offer_finish[0]": "robson01@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": "Autem et voluptas nisi perferendis itaque.",
        "image": "{file}",
        "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/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": "Placeat accusantium sint suscipit aut ut.",
        "image": "{file}",
        "order": 4,
        "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/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": "Inventore tenetur temporibus enim temporibus ipsam autem.",
        "groups_stories_id": "4890f063-bd60-3a0e-9473-6dcd94380705",
        "midia": "{file}",
        "order": 4,
        "link": "Labore voluptate suscipit adipisci eligendi.",
        "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": "Non nihil omnis consequatur.",
        "groups_stories_id": "b5fc1490-eff7-3a3e-9d41-f56eb6f0f644",
        "midia": "{file}",
        "order": 7,
        "link": "Molestias quasi cumque velit rerum dolore non.",
        "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": "be7881fd-8025-3bde-8fd3-a777190c07b8",
        "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/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": "Architecto id deleniti perspiciatis esse debitis ipsam.",
        "color": "Sint voluptatem repellat hic porro error pariatur.",
        "background_color": "Sequi rerum saepe laborum.",
        "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": "Incidunt ea maiores cupiditate deleniti.",
        "color": "Aut ut eos maiores eum.",
        "background_color": "Ut et debitis enim repellendus quam sapiente nobis.",
        "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": "Nisi id autem sint dolores cupiditate.",
        "text": "Ad laudantium animi illo. Explicabo voluptate ut quas cum. Reiciendis et voluptatibus non aperiam vel."
}
})
.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": "Danielle Valentin Marin",
        "password_random": "1",
        "password": "123456",
        "password_confirmation": "123456",
        "email": "fonseca.dener@example.org",
        "is_active": "0",
        "roles[0]": "7962e25a-348e-3d64-bbbd-398ea633f88e"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/users

Permission required

users.create

Parameters

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

Autocomplete users

List a maximum of 50 items.

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]": "0db98d13-330b-3a3f-acf1-4ee5af6605d2"
}
})
.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}