Introduction

Welcome to the generated API reference.

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

Header

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

Controlling requests

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

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

Errors

API uses the following error codes:

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

About app

Get about app

const axios = require('axios');

axios({
    "method": "get",
    "url": "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
});

null

HTTP Request

GET api/v1/admin/about-app

Permission required

about-app.edit

Update about app

const axios = require('axios');

axios({
    "method": "post",
    "url": "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": "Omnis dolores ex nostrum dolorem.",
        "file": "{file}",
        "file_mobile": "{file}",
        "video": "{file}",
        "text": "Nisi et labore ut corrupti vel quis. In et quia enim. In sunt atque consequatur a ipsum nihil ea."
}
})
.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	file	nullable\|file\|mimes: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
text	string	nullable\|string\|max:60000	HTML allowed

About company

Get about company

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
});

null

HTTP Request

GET api/v1/admin/company-app

Permission required

about-company.edit

Update about company

const axios = require('axios');

axios({
    "method": "post",
    "url": "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 enim alias est repudiandae quas.",
        "file": "{file}",
        "file_mobile": "{file}",
        "video": "{file}",
        "text": "Alias et quaerat omnis eos. Ut et qui similique et rerum corporis mollitia. Ipsa totam est provident impedit odio similique."
}
})
.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	file	nullable\|file\|mimes: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
text	string	nullable\|string\|max:60000	HTML allowed

Authentication

Login

5 login attempts can be performed every 1 minute.

const axios = require('axios');

axios({
    "method": "post",
    "url": "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": "aaron.dominato@example.com",
        "password": "N0qAqyoFAE",
        "token_name": "My Computer"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

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

HTTP Request

POST api/v1/admin/auth/login

No authentication required

Parameters

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

Password recovery

Send password reset link do user

const axios = require('axios');

axios({
    "method": "post",
    "url": "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": "marques.juliane@example.net"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

{
    "message": "Success message"
}

HTTP Request

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

No authentication required

Parameters

Parameter	Type	Validation	Description
email	string	required\|email

Reset the given user's password.

const axios = require('axios');

axios({
    "method": "post",
    "url": "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

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

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
});

null

HTTP Request

GET api/v1/admin/auth/user

Get all tokens

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
});

null

HTTP Request

GET api/v1/admin/auth/tokens

Delete token

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

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

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
});

{
    "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

Parameter	Type	Validation	Description
uuid	string	string
is_active	boolean	boolean

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

Parameter	Type	Validation	Description
name	string	string\|max:191
order	integer	required\|integer
is_active	boolean	boolean

Cliente

Get all clientes

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
});

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.

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
});

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

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": "mOj9QTBiSo",
        "password_confirmation": "my_new_password",
        "name": "Asperiores in et sapiente dolores.",
        "email": "rosa.maicon@example.net",
        "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

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
});

{
    "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

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": "Wly9Lp2yaN",
        "password_confirmation": "my_new_password",
        "name": "Magnam soluta voluptatibus sunt optio qui.",
        "email": "clarice.guerra@example.com",
        "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/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

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
});

{
    "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

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
});

null

HTTP Request

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

Permission required

customers.show

Remove cliente

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

Get all clientes deletedos

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
});

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

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
});

{
    "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

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
});

null

HTTP Request

GET api/v1/admin/customers-deleted/{uuid}

Permission required

customers-deleted.show

Dashboard

Get summary of data

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
});

null

HTTP Request

GET api/v1/admin/dashboard

Denunciations

Get all denunciations

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
});

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

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
});

null

HTTP Request

GET api/v1/admin/denunciations/{denunciation}

Permission required

denunciations.show

deactive comment

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": "7611f3ab-0aee-3198-8b60-c8cfa6a94e5f",
        "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

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
});

null

HTTP Request

GET api/v1/admin/faq

Permission required

faq.list

Query Parameters

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

Create faq

const axios = require('axios');

axios({
    "method": "post",
    "url": "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": "Veniam eaque officia placeat ut.",
        "text": "Fa\u00e7a-lhe tambem elogios; elle gosta muito de ser nomeado protonotario apostolico. No uso commum, basta protonotario. --Justamente, assentiram todos. Jos\u00e9 Dias, ouvida por ella, \u00e1 tarde, na sala de visitas. O aggregado disse-lho summariamente, demorando-se um pouco mais, e n\u00e3o seria capaz de deduzir uma cousa de choro... Elle chegou a mostrar-se arrependido, e saiu; eu ent\u00e3o, para n\u00e3o tomar suadouro, mas tu est\u00e1s constipado; conhece-se pela voz. Tentei rir, para mostrar que Capit\u00fa recuou um pouco. Era occasi\u00e3o de pegal-a, puxal-a e beijal-a... Ideia s\u00f3 ideia sem bra\u00e7os! Os meus ficaram caidos e mortos. N\u00e3o conhecia nada da Escriptura. Se conhecesse, \u00e9 provavel que, com a filha tinha come\u00e7ado outra cousa, mette-se ent\u00e3o o imperador entrava no coche, inclinava-se e fazia um gesto para tiral-os outra vez a m\u00e3o para alguma universidade, e ao pae encantados della; o pae, e demais amava particularmente os passarinhos. Tinha-os de varia especie, muitas intellectuaes, egualmente intensas. Grande homem que podia vir a ser padre._ Conheci aqui o meu velho Marcolini, n\u00e3o s\u00f3 para o ceu. O ceu estava coberto. Capit\u00fa falou novamente da nossa infancia: Chora, menina, chora, Chora, porque n\u00e3o conhecia ainda esta combina\u00e7\u00e3o. N\u00e3o, uma vez que tinhamos outra vara disponivel, pedia-a para mim, inclinada sobre a nuca por um velho professor amigo do tio Cosme, sacudindo a barriga, chamou-me peralta; mas Jos\u00e9 Dias curou o feitor e uma botica. Havia ent\u00e3o um anda\u00e7o de febres; Jos\u00e9 Dias fez um gesto cheio de misericordia, consentiu em que brincavamos assim, era muito commum ouvir \u00e1 minha vida se casa bem \u00e1 defini\u00e7\u00e3o. Cantei um _duo_ ternissimo, depois um _quatuor..._ Mas n\u00e3o adeantemos; vamos \u00e1 primeira tarde, em que me tivessem ouvido, porque a minha m\u00e3e a promessa de tantos annos... Mas, que \u00e9 isso, mana Gloria? Est\u00e1 chorando? Ora esta! Pois isto \u00e9 cousa de outra, isto \u00e9, que a dispensasse da promessa? --N\u00e3o, n\u00e3o pe\u00e7o. Est\u00e1s tonto, Bentinho? E como havia de trabalhar contra a egreja; s\u00f3.",
        "order": 7,
        "is_active": "0"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/faq

Permission required

faq.create

Parameters

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

Get additional information

const axios = require('axios');

axios({
    "method": "get",
    "url": "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
});

{
    "next_order": 5
}

HTTP Request

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

Export faq

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
});

{
    "file_url": "{url}"
}

HTTP Request

GET api/v1/admin/faq/export

Permission required

faq.export

Query Parameters

Parameter	Type	Validation	Description
orderBy	string	string	Default: `id:asc`. Available fields: `id` `name` `order` `is_active` `created_at` `updated_at`
search	string	string	Search in the fields: `uuid` `name` `email`
is_active	integer	integer	Available values: `0` `1`
created_at[0]	string	string	ISO 8601 `Y-m-d\TH:i:sP` Initial date
created_at[1]	string	string	ISO 8601 `Y-m-d\TH:i:sP` Final date

Get faq

const axios = require('axios');

axios({
    "method": "get",
    "url": "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
});

null

HTTP Request

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

Permission required

faq.show

Update faq

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": "In debitis assumenda enim laborum.",
        "text": "Alias animi non modi voluptatem. Vitae corporis nihil optio et soluta. Animi nobis deserunt et cupiditate. Earum molestias nesciunt beatae sint omnis quo debitis.",
        "order": 2,
        "is_active": "0"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/faq/{faq}

Permission required

faq.edit

Parameters

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

Remove faq

const axios = require('axios');

axios({
    "method": "delete",
    "url": "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

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
});

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

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": "Omnis itaque quia in sit.",
        "order": 3,
        "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.

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
});

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

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
});

{
    "next_order": 5
}

HTTP Request

GET api/v1/admin/groups-stories/additional-information

Get group

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
});

null

HTTP Request

GET api/v1/admin/groups-stories/{group}

Permission required

group-stories.show

Update group

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": "Accusamus perspiciatis omnis pariatur autem dolor eaque ut saepe.",
        "text": "A suscipit expedita molestiae quis praesentium. Aut natus quas sit alias quibusdam quo quo. Molestiae in iste ipsa corrupti.",
        "icon": "{file}",
        "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/groups-stories/{group}

Permission required

group-stories.edit

Parameters

Parameter	Type	Validation
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

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

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
});

null

HTTP Request

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

Permission required

how-it-works.list

Query Parameters

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

Create how it works

const axios = require('axios');

axios({
    "method": "post",
    "url": "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": "Corrupti ipsum asperiores molestiae repudiandae.",
        "text": "Era ainda bonita e mo\u00e7a, mas teimava em dizer que o cardeal Mastai evidentemente f\u00f4ra talhado para a egreja, o que foi descoberta a tempo, e elle expulso do conservatorio. Tudo se teria passado sem mais nada, e para traz. --No tempo em que perdia a consciencia n\u00e3o lhe dou mo\u00e7a.\u00bb N\u00e3o consultes diccionarios. _Casmurro_ n\u00e3o est\u00e1 no texto do poeta; \u00e9 uma excrescencia para imitar as _Mulheres patuscas de Windsor._ Este ponto \u00e9 contestado pelos satanistas com alguma for\u00e7a, e eu \u00e9ramos pequenos. A porta n\u00e3o tinha nada. Nem por isso mesmo, quiz que lhe posso valer, anjo do ceu? N\u00e3o hei de crer...? Mano Cosme, voc\u00ea que acha? Tio Cosme vivia com rapazes, que me n\u00e3o fizesse discreto. Entretanto, como prima Justina para se despedir de mim; mas, ainda ahi nos detivemos por alguns minutos, falando do calor e da proxima festa da Concei\u00e7\u00e3o, dos meus sapatos, da minha entrada no seminario, mas como ha de ouvir dizer nada de pessoas dignas, que merecem tudo... Ahi est\u00e1! nunca ninguem me ha de falar. --Pegue-se tambem com Deus,--com Deus e a filha... Padua obedeceu; confessou que certamente n\u00e3o era formosa, talvez nem tivesse gra\u00e7a; os cabellos iam acabando, por mais que eu, receioso disso mesmo, buscasse agora raz\u00f5es para animal-a. Capit\u00fa, quando havia chamado minha m\u00e3e tinha na sala de visitas, quando ouvi proferir o meu desejo era nenhum, cr\u00ea-se facilmente, sem ser preciso jurar pelo ceu nem pela terra. Meu desejo era nenhum, cr\u00ea-se facilmente, sem ser primeiramente padre, disse-lhe eu mordendo os bei\u00e7os. --Bem; comece pelas meias pretas, depois vir\u00e3o as roxas. O que aqui viveu e morreu... E explicou-me um dia notou a differen\u00e7a, dizendo que os olhos de ressaca de Capit\u00fa com infinito prazer. --Obrigado, Capit\u00fa, muito obrigado; estimo que voc\u00ea tem? --Eu? Nada. --Nada, n\u00e3o; voc\u00ea tem medo. --Medo de que? --Medo de apanhar, de ser padre, p\u00f3de ir; mas, se n\u00e3o mudar, faz-se outra cousa, um perfil, que disse ser o que \u00e9; affirmo desde j\u00e1 que \u00e9 em desespero; negocio de relatorio. Voc\u00ea j\u00e1.",
        "order": 10,
        "is_active": "0"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

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

Permission required

how-it-works.create

Parameters

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

Get additional information

const axios = require('axios');

axios({
    "method": "get",
    "url": "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
});

{
    "next_order": 5
}

HTTP Request

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

Export how it works

const axios = require('axios');

axios({
    "method": "get",
    "url": "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
});

{
    "file_url": "{url}"
}

HTTP Request

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

Permission required

how-it-works.export

Query Parameters

Parameter	Type	Validation	Description
orderBy	string	string	Default: `id:asc`. Available fields: `id` `name` `order` `is_active` `created_at` `updated_at`
search	string	string	Search in the fields: `uuid` `name` `email`
is_active	integer	integer	Available values: `0` `1`
created_at[0]	string	string	ISO 8601 `Y-m-d\TH:i:sP` Initial date
created_at[1]	string	string	ISO 8601 `Y-m-d\TH:i:sP` Final date

Get how it works

const axios = require('axios');

axios({
    "method": "get",
    "url": "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
});

null

HTTP Request

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

Permission required

how-it-works.show

Update how it works

const axios = require('axios');

axios({
    "method": "post",
    "url": "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": "Est modi quia ut magni aliquid.",
        "text": "Modi id vero explicabo officiis qui et consectetur. Non magni amet suscipit in. Non quisquam culpa commodi incidunt quia et vel. Voluptas molestiae mollitia voluptas ducimus porro quia.",
        "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/how-it-works/{how_it_works}

Permission required

how-it-works.edit

Parameters

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

Remove how it works

const axios = require('axios');

axios({
    "method": "delete",
    "url": "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

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
});

null

HTTP Request

GET api/v1/admin/logs

Permission required

log.list

Query Parameters

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

Export logs

const axios = require('axios');

axios({
    "method": "get",
    "url": "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
});

{
    "file_url": "{url}"
}

HTTP Request

GET api/v1/admin/logs/export

Permission required

log.export

Query Parameters

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

Get log

const axios = require('axios');

axios({
    "method": "get",
    "url": "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
});

null

HTTP Request

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

Permission required

log.show

News

Get all news

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
});

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

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": "7717e8e8-7506-32c3-a47c-478aa8777f20",
        "is_active": "0"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/news/active-deactive/{news}

Permission required

news.edit

Parameters

Parameter	Type	Validation	Description
uuid	string	string
is_active	boolean	boolean

Create news

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}",
        "store_id": "d54b4377-665e-35af-a606-a7ef13ae5d62",
        "offer_id": "ff074dc8-b009-38ce-91bb-2460857fe6d6",
        "title": "Dolor sit consequuntur doloribus beatae modi.",
        "text": "Voluptates autem harum amet beatae. Quae quia maiores quod et. Vel sint et iure nobis consequatur veritatis. A illo in perferendis 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

Permission required

news.create

Parameters

Parameter	Type	Validation	Description
capa	file	nullable\|mimes:jpg,jpeg,png\|max:4mb
store_id	string	string\|max:191
offer_id	string	string\|max:191
title	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

Export news

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
});

{
    "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

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
});

null

HTTP Request

GET api/v1/admin/news/{news}

Permission required

news.show

Update news

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": "ae53e301-d897-3989-b9fb-67aec895a763",
        "store_id": "a9106c6b-7862-3817-a375-742a3e5a194c",
        "offer_id": "d5de4c56-5dd6-30fb-b7fe-a93cbaeeafb6",
        "title": "Distinctio rerum ut non autem.",
        "text": "Itaque est assumenda itaque odit aut officia. Iure quae hic nam eos in vel. Officia nemo qui enim necessitatibus autem aut quis recusandae.",
        "scheduled_at": "2019-07-29T00:00:00-03:00",
        "is_active": "1"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/news/{news}

Permission required

news.edit

Parameters

Parameter	Type	Validation	Description
capa	file	sometimes\|nullable\|mimes:jpg,jpeg,png\|max:4mb
capa_delete	string	sometimes\|nullable\|string\|max:191
store_id	string	sometimes\|nullable\|string\|max:191
offer_id	string	sometimes\|nullable\|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

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

Get all news deleted

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
});

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

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
});

{
    "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

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
});

null

HTTP Request

GET api/v1/admin/news-deleted/{uuid}

Permission required

news-deleted.show

Offers

Get all offers

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
});

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
is_active	integer	integer	Available values: `0` `1`
under_review	integer	integer	Available values: `0` `1`
is_exclusive_app	boolean	boolean	static(1) Available values: `0` `1`
is_internacional	boolean	boolean	static(1) Available values: `0` `1`
free_shipping	boolean	boolean	static(1) 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.

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
});

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

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": "Et quidem ad suscipit quibusdam.",
        "store_id": "59e62b73-6f1c-3648-89c0-e53876612c0d",
        "perfil_id[]": "15c4bdc6-1566-394c-b13d-3b07a3791107",
        "category_id[]": "2414cf0e-8da4-382b-90dc-7f3e0064739d",
        "link": "Beatae tempore eos velit et.",
        "type": "'oferta'",
        "discount_type": "'porcentagem'",
        "price": "Accusantium in dolore aut officia quia laudantium.",
        "discount": "Aut numquam rem voluptate assumenda consequatur cumque qui eligendi.",
        "sku": "Expedita vero vel mollitia.",
        "is_active": "1",
        "scheduled_at": "2019-07-29T23:59:59-03:00",
        "images[]": "{file}",
        "button_text": "9f39685e-f220-36a7-a4d1-ddeb5792d1a3",
        "color_primary": "a2d36f0a-279d-39a4-8316-3cf9147784cb",
        "color_secundary": "70edc9ca-aae5-3fdf-8be3-1c9e4319ab79",
        "is_exclusive_app": "0",
        "is_internacional": "1",
        "free_shipping": "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/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:191
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
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
is_exclusive_app	boolean	sometimes\|nullable\|boolean	Default true
is_internacional	boolean	sometimes\|nullable\|boolean	Default true
free_shipping	boolean	sometimes\|nullable\|boolean	Default true

Export offers

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
});

{
    "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

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
});

null

HTTP Request

GET api/v1/admin/offers/{offers}

Permission required

offers.show

Edit offer

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": "Dolorem voluptas a sit et.",
        "perfil_id[]": "cc1b33fb-5793-3066-a239-339699b22ec3",
        "store_id": "2029a643-3af3-3935-83ab-4014b2183730",
        "category_id[]": "4b9951eb-07d9-3e3d-9856-307f3928d743",
        "link": "Adipisci maxime non enim numquam.",
        "type": "'oferta'",
        "discount_type": "'porcentagem'",
        "price": "Et quo non aperiam.",
        "discount": "Modi quo quo quaerat repellendus quas omnis earum.",
        "sku": "Qui assumenda nihil reprehenderit aut necessitatibus veniam.",
        "is_active": "1",
        "scheduled_at": "2019-07-29T23:59:59-03:00",
        "resend_notification": "1",
        "under_review": "1",
        "images": "{file}",
        "imagens_no_delete[]": "0f989b03-92a9-3e06-bbe5-556a02378c77",
        "button_text": "2097b96f-b731-3ed9-9e82-a46acc64c828",
        "color_primary": "0c624fee-28d8-3d80-abd5-a0060b20a0f0",
        "color_secundary": "f8639899-ce61-3ac0-bc71-b5902f571884",
        "is_exclusive_app": "0",
        "is_internacional": "0",
        "free_shipping": "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/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:191
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
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
is_exclusive_app	boolean	sometimes\|nullable\|boolean	Default true
is_internacional	boolean	sometimes\|nullable\|boolean	Default true
free_shipping	boolean	sometimes\|nullable\|boolean	Default true

Remove Offer

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

Get all offers deleted

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
});

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`
is_exclusive_app	boolean	boolean	static(1) Available values: `0` `1`
is_internacional	boolean	boolean	static(1) Available values: `0` `1`
free_shipping	boolean	boolean	static(1) 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

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
});

{
    "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

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
});

null

HTTP Request

GET api/v1/admin/offers-deleted/{uuid}

Permission required

offers-deleted.show

On Sales

Get all on sales

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
});

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.

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
});

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

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": "Optio odio quia cumque magnam et commodi.",
        "offer_id": "0199eef6-5887-33c8-95da-795970eb1abd",
        "link": "Voluptatem pariatur aut nam qui.",
        "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

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
});

{
    "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

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
});

null

HTTP Request

GET api/v1/admin/on-sales/{onsale}

Permission required

offers.show

Edit on sale

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": "Veritatis praesentium quis animi autem molestiae error.",
        "offer_id": "32184bdd-891d-37e2-9ae0-3ba601919961",
        "link": "Error doloribus fugit omnis ut.",
        "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

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

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
});

null

HTTP Request

GET api/v1/admin/onboarding

Permission required

onboarding.list

Query Parameters

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

Create onboarding

const axios = require('axios');

axios({
    "method": "post",
    "url": "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": "Assumenda et quam in.",
        "frase2": "Inventore et reprehenderit illum sed eius et id inventore.",
        "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

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
});

{
    "next_order": 5
}

HTTP Request

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

Get onboarding

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
});

null

HTTP Request

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

Permission required

onboarding.show

Update onboarding

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": "Eligendi labore expedita quisquam natus asperiores.",
        "frase2": "Exercitationem quo adipisci harum nesciunt.",
        "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

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

Perfis

Get all perfil

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
});

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

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": "e826e2a1-378c-3592-ac95-8f897bd31f1b",
        "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.

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
});

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

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": "Omnis officia optio ab dolore facilis voluptatem.",
        "icon": "{file}",
        "order": 5,
        "is_active": "1"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

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

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
});

{
    "next_order": 5
}

HTTP Request

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

Export perfis

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
});

{
    "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

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
});

null

HTTP Request

GET api/v1/admin/perfis/{perfis}

Permission required

perfis.show

Update perfil

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": "Quis et beatae necessitatibus ut veniam.",
        "icon_delete": "2019da55-a304-3a8c-b472-a341dc718349",
        "icon": "{file}",
        "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/perfis/update/{perfis}

Permission required

perfis.edit

Parameters

Parameter	Type	Validation
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

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

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
});

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

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
});

null

HTTP Request

GET api/v1/admin/policy-cookies

Permission required

privacy-policy.edit

Update privacy policy

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": "Cum cumque maxime impedit accusamus.",
        "text": "Labore modi sint fuga quas eos nobis. Perferendis voluptas modi nam doloremque modi nisi consectetur. Ut quis quod optio odit aut quia quasi. Nisi ipsam maiores nemo itaque quia suscipit."
}
})
.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

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
});

null

HTTP Request

GET api/v1/admin/privacy-policy

Permission required

privacy-policy.edit

Update privacy policy

const axios = require('axios');

axios({
    "method": "post",
    "url": "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": "Eum cum vel deserunt est totam esse.",
        "text": "Nobis est cumque maxime ex asperiores qui eveniet soluta. Aut qui sapiente qui aut veniam vitae ut laboriosam. Consequatur aut quia iure pariatur aut voluptatem voluptas."
}
})
.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

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
});

null

HTTP Request

GET api/v1/admin/push-city

Permission required

push-city.list

Query Parameters

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

Create push

const axios = require('axios');

axios({
    "method": "post",
    "url": "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": "Nihil alias dicta ea qui harum magnam.",
        "body": "Qui qui hic ut non. Magni minus praesentium velit ut. Earum cum natus pariatur enim voluptatum vel.",
        "url": "https:\/\/rodrigues.br\/omnis-ut-facere-nihil-reiciendis-nemo-reprehenderit.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

Permission required

push-city.create

Parameters

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

Export push

const axios = require('axios');

axios({
    "method": "get",
    "url": "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
});

{
    "file_url": "{url}"
}

HTTP Request

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

Permission required

push-city.export

Query Parameters

Parameter	Type	Validation	Description
orderBy	string	string	Default: `id:asc`. Available fields: `id` `title` `body` `scheduled_at` `send_at` `created_at` `city.name`
search	string	string	Search in the fields: `uuid` `title` `body` `city.name`
created_at[0]	string	string	ISO 8601 `Y-m-d\TH:i:sP` Initial date
created_at[1]	string	string	ISO 8601 `Y-m-d\TH:i:sP` Final date

Get push

const axios = require('axios');

axios({
    "method": "get",
    "url": "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
});

null

HTTP Request

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

Permission required

push-city.show

Remove push

const axios = require('axios');

axios({
    "method": "delete",
    "url": "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

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
});

null

HTTP Request

GET api/v1/admin/push-general

Permission required

push-general.list

Query Parameters

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

Create push

const axios = require('axios');

axios({
    "method": "post",
    "url": "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": "Aliquid est consequuntur minus enim.",
        "body": "Quia odio ducimus a ipsa. Mollitia est recusandae id et dolor. Et quos natus tempore neque eveniet.",
        "url": "http:\/\/www.zamana.com.br\/ea-doloremque-sunt-vel-laboriosam",
        "scheduled_at": "2019-07-29T23:59:59-03:00"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/push-general

Permission required

push-general.create

Parameters

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

Export push

const axios = require('axios');

axios({
    "method": "get",
    "url": "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
});

{
    "file_url": "{url}"
}

HTTP Request

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

Permission required

push-general.export

Query Parameters

Parameter	Type	Validation	Description
orderBy	string	string	Default: `id:asc`. Available fields: `id` `title` `body` `scheduled_at` `send_at` `created_at`
search	string	string	Search in the fields: `uuid` `title` `body`
created_at[0]	string	string	ISO 8601 `Y-m-d\TH:i:sP` Initial date
created_at[1]	string	string	ISO 8601 `Y-m-d\TH:i:sP` Final date

Get push

const axios = require('axios');

axios({
    "method": "get",
    "url": "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
});

null

HTTP Request

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

Permission required

push-general.show

Remove push

const axios = require('axios');

axios({
    "method": "delete",
    "url": "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

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
});

null

HTTP Request

GET api/v1/admin/push-state

Permission required

push-state.list

Query Parameters

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

Create push

const axios = require('axios');

axios({
    "method": "post",
    "url": "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": "Occaecati sed aperiam maiores omnis.",
        "body": "Error ut alias autem alias. Eum incidunt voluptatem et. Sed voluptas quasi harum id veniam.",
        "url": "https:\/\/www.oliveira.com\/tempora-dolor-aut-voluptatum-tenetur",
        "scheduled_at": "2019-07-29T23:59:59-03:00"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/push-state

Permission required

push-state.create

Parameters

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

Export push

const axios = require('axios');

axios({
    "method": "get",
    "url": "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
});

{
    "file_url": "{url}"
}

HTTP Request

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

Permission required

push-state.export

Query Parameters

Parameter	Type	Validation	Description
orderBy	string	string	Default: `id:asc`. Available fields: `id` `title` `body` `scheduled_at` `send_at` `created_at` `state.name`
search	string	string	Search in the fields: `uuid` `title` `body` `state.name`
created_at[0]	string	string	ISO 8601 `Y-m-d\TH:i:sP` Initial date
created_at[1]	string	string	ISO 8601 `Y-m-d\TH:i:sP` Final date

Get push

const axios = require('axios');

axios({
    "method": "get",
    "url": "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
});

null

HTTP Request

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

Permission required

push-state.show

Remove push

const axios = require('axios');

axios({
    "method": "delete",
    "url": "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

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
});

null

HTTP Request

GET api/v1/admin/push-user

Permission required

push-user.list

Query Parameters

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

Create push

const axios = require('axios');

axios({
    "method": "post",
    "url": "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": "3d0aa5e0-bd9a-34e8-9ed6-1ca146cc4902",
        "title": "Dolorem culpa commodi sed.",
        "body": "Nulla velit aut sint. Rerum velit qui ipsum et.",
        "url": "http:\/\/montenegro.com.br\/",
        "scheduled_at": "2019-07-29T23:59:59-03:00"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/push-user

Permission required

push-user.create

Parameters

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

Export push

const axios = require('axios');

axios({
    "method": "get",
    "url": "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
});

{
    "file_url": "{url}"
}

HTTP Request

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

Permission required

push-user.export

Query Parameters

Parameter	Type	Validation	Description
orderBy	string	string	Default: `id:asc`. Available fields: `id` `title` `body` `scheduled_at` `send_at` `created_at` `user.name`
search	string	string	Search in the fields: `uuid` `title` `body` `user.name`
created_at[0]	string	string	ISO 8601 `Y-m-d\TH:i:sP` Initial date
created_at[1]	string	string	ISO 8601 `Y-m-d\TH:i:sP` Final date

Get push

const axios = require('axios');

axios({
    "method": "get",
    "url": "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
});

null

HTTP Request

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

Permission required

push-user.show

Remove push

const axios = require('axios');

axios({
    "method": "delete",
    "url": "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

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
});

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

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
});

null

HTTP Request

GET api/v1/admin/reports/error/{reportError}

Permission required

reports-error.show

Remove report error

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

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
});

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

Get report offer finish

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
});

null

HTTP Request

GET api/v1/admin/reports/finish/{offer}

Permission required

reports-finish.show

Remove report offer finish

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

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
});

{
    "url": "{url}"
}

HTTP Request

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

Parameters

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

Roles

Get all roles

const axios = require('axios');

axios({
    "method": "get",
    "url": "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
});

null

HTTP Request

GET api/v1/admin/roles

Permission required

roles.list

Query Parameters

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

Create role

const axios = require('axios');

axios({
    "method": "post",
    "url": "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": "Ducimus qui omnis eius fuga. Id odio quaerat accusantium voluptatum eos.",
        "permissions[0]": "0f314b13-faf4-3675-b4dd-fc1644dfc46b"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/roles

Permission required

roles.create

Parameters

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

Autocomplete roles

const axios = require('axios');

axios({
    "method": "get",
    "url": "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
});

null

HTTP Request

GET api/v1/admin/roles/autocomplete

Query Parameters

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

Export roles

const axios = require('axios');

axios({
    "method": "get",
    "url": "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
});

{
    "file_url": "{url}"
}

HTTP Request

GET api/v1/admin/roles/export

Permission required

roles.export

Query Parameters

Parameter	Type	Validation	Description
orderBy	string	string	Default: `id:asc`. Available fields: `id` `name` `description` `is_system` `created_at` `updated_at` `permissions_count` `users_count`
search	string	string	Search in the fields: `uuid` `name` `description`
created_at[0]	string	string	ISO 8601 `Y-m-d\TH:i:sP` Initial date
created_at[1]	string	string	ISO 8601 `Y-m-d\TH:i:sP` Final date

Get role

const axios = require('axios');

axios({
    "method": "get",
    "url": "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
});

null

HTTP Request

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

Permission required

roles.show

Update role

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": "Esse in ut eaque veritatis voluptatum hic.",
        "description": "Ipsum sit in deserunt voluptas eum qui. Quis inventore omnis voluptatibus laudantium.",
        "permissions[0]": "ccb13369-61a4-3c12-9c11-469b91faf1d9"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

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

Permission required

roles.edit

Parameters

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

Remove role

const axios = require('axios');

axios({
    "method": "delete",
    "url": "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

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
});

null

HTTP Request

GET api/v1/admin/settings/general

Permission required

settings-general.list

Update settings

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",
        "email_support": "adriano30@example.net",
        "whatsapp_group": "Sapiente in hic eos et.",
        "show_whatsapp": "0",
        "facebook": "Itaque ducimus unde est dolor.",
        "instagram": "Temporibus commodi cum voluptatem delectus quam aut est quam.",
        "telegram": "Ut aut consequatur omnis illum et sapiente.",
        "url_site": "Qui debitis perspiciatis est.",
        "phone_support": "(11) 96789-8554",
        "whatsapp_number": "(62) 99893-8100"
}
})
.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
email_support	string	string\|email
whatsapp_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
phone_support	integer	required\|string\|phone	Format `(99) 9999-9999` OR `(99) 99999-9999`
whatsapp_number	integer	required\|string\|phone	Format `(99) 9999-9999` OR `(99) 99999-9999`

Settings Notifications

Get settings

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
});

null

HTTP Request

GET api/v1/admin/settings/notifications

Permission required

settings-notifications.list

Update settings

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": {
        "report_a_problem[0]": "ualves@example.com"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/settings/notifications

Permission required

settings-notifications.edit

Parameters

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

Stores

Get all stores

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
});

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.

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
});

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

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": "Ut nostrum nobis illo accusantium iste consequatur.",
        "image": "{file}",
        "order": 8,
        "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

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
});

{
    "next_order": 5
}

HTTP Request

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

Export stores

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
});

{
    "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

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
});

null

HTTP Request

GET api/v1/admin/stores/{stores}

Permission required

stores.show

Update perfil

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": "Eius id ipsam dolores architecto.",
        "image": "{file}",
        "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/stores/update/{stores}

Permission required

stores.edit

Parameters

Parameter	Type	Validation
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

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

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
});

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

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
});

{
    "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

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
});

null

HTTP Request

GET api/v1/admin/stores-deleted/{uuid}

Permission required

stores-deleted.show

Stories

Get all stories

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
});

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

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": "Ipsam cum iure veritatis inventore ullam at vel deserunt.",
        "groups_stories_id": "2b7cf613-ffff-3d59-859b-546760b8e957",
        "midia": "{file}",
        "order": 9,
        "link": "Placeat maiores reprehenderit dolores beatae.",
        "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
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.

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
});

{
    "next_order": 5
}

HTTP Request

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

get story

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
});

null

HTTP Request

GET api/v1/admin/stories/{story}

Permission required

story.show

Update story

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": "Temporibus molestias enim beatae corporis tempora.",
        "groups_stories_id": "305d8398-731c-3425-a8b0-ff73acc8f3e4",
        "midia": "{file}",
        "order": 7,
        "link": "Corporis assumenda laborum ullam occaecati est sit.",
        "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
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

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

System Log

Get all logs

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
});

null

HTTP Request

GET api/v1/admin/system-log

Permission required

system-log.list

Query Parameters

Parameter	Type	Validation	Description
limit	integer	integer	Default: `20` Max: `100`
page	integer	integer
orderBy	string	string	Default: `id:asc`. Available fields: `id` `message` `url` `created_at`
search	string	string	Search in the fields: `uuid` `message` `url`
level	string	string	Available values: `ALERT` `CRITICAL` `DEBUG` `EMERGENCY` `ERROR` `INFO` `NOTICE` `WARNING`
method	string	string	Available values: `DELETE` `GET` `POST`
created_at[0]	string	string	ISO 8601 `Y-m-d\TH:i:sP` Initial date
created_at[1]	string	string	ISO 8601 `Y-m-d\TH:i:sP` Final date

Export logs

const axios = require('axios');

axios({
    "method": "get",
    "url": "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
});

{
    "file_url": "{url}"
}

HTTP Request

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

Permission required

system-log.export

Query Parameters

Parameter	Type	Validation	Description
orderBy	string	string	Default: `id:asc`. Available fields: `id` `message` `url` `created_at`
search	string	string	Search in the fields: `uuid` `message` `url`
level	string	string	Available values: `ALERT` `CRITICAL` `DEBUG` `EMERGENCY` `ERROR` `INFO` `NOTICE` `WARNING`
method	string	string	Available values: `DELETE` `GET` `POST`
created_at[0]	string	string	ISO 8601 `Y-m-d\TH:i:sP` Initial date
created_at[1]	string	string	ISO 8601 `Y-m-d\TH:i:sP` Final date

Get log

const axios = require('axios');

axios({
    "method": "get",
    "url": "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
});

null

HTTP Request

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

Permission required

system-log.show

Terms Of Use

Get terms of use

const axios = require('axios');

axios({
    "method": "get",
    "url": "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
});

null

HTTP Request

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

Permission required

terms-of-use.edit

Update terms of use

const axios = require('axios');

axios({
    "method": "post",
    "url": "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": "Sequi ab ab occaecati similique eius omnis rem.",
        "text": "Minus nulla perferendis quas reiciendis ut sunt voluptas ipsum. Laboriosam neque quas amet ipsam animi qui."
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

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

Permission required

terms-of-use.edit

Parameters

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

Users

Get all users

const axios = require('axios');

axios({
    "method": "get",
    "url": "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
});

null

HTTP Request

GET api/v1/admin/users

Permission required

users.list

Query Parameters

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

Create user

const axios = require('axios');

axios({
    "method": "post",
    "url": "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": "Sra. Mia Fontes",
        "password_random": "1",
        "password": "123456",
        "password_confirmation": "123456",
        "email": "hferraz@example.net",
        "is_active": "1",
        "roles[0]": "b74173cc-e7ec-3629-8c8f-b946b39f2e5f"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/users

Permission required

users.create

Parameters

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

Autocomplete users

List a maximum of 50 items.

const axios = require('axios');

axios({
    "method": "get",
    "url": "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
});

null

HTTP Request

GET api/v1/admin/users/autocomplete

Query Parameters

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

Export users

const axios = require('axios');

axios({
    "method": "get",
    "url": "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
});

{
    "file_url": "{url}"
}

HTTP Request

GET api/v1/admin/users/export

Permission required

users.export

Query Parameters

Parameter	Type	Validation	Description
orderBy	string	string	Default: `id:asc`. Available fields: `id` `name` `email` `avatar` `is_active` `created_at` `updated_at`
search	string	string	Search in the fields: `uuid` `name` `email`
is_active	integer	integer	Available values: `0` `1`
created_at[0]	string	string	ISO 8601 `Y-m-d\TH:i:sP` Initial date
created_at[1]	string	string	ISO 8601 `Y-m-d\TH:i:sP` Final date

Get user

const axios = require('axios');

axios({
    "method": "get",
    "url": "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
});

null

HTTP Request

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

Permission required

users.show

Update user

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": "1",
        "roles[0]": "6995d06f-bbaa-3634-87fa-6bc93cdb42d5"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

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

Permission required

users.edit

Parameters

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

Remove user

const axios = require('axios');

axios({
    "method": "delete",
    "url": "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.

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
});

null

HTTP Request

GET api/v1/admin/webservice/cities

Query Parameters

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

States

const axios = require('axios');

axios({
    "method": "get",
    "url": "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
});

null

HTTP Request

GET api/v1/admin/webservice/states

Query Parameters

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

Find zipcode

const axios = require('axios');

axios({
    "method": "get",
    "url": "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
});

null

HTTP Request

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

Introduction

Header

Controlling requests

Errors

About app

Get about app

HTTP Request

Permission required

Update about app

HTTP Request

Permission required

Parameters

About company

Get about company

HTTP Request

Permission required

Update about company

HTTP Request

Permission required

Parameters

Authentication

Login

HTTP Request

No authentication required

Parameters

Password recovery

HTTP Request

No authentication required

Parameters

Reset the given user's password.

HTTP Request

Logout

HTTP Request

Get the authenticated user

HTTP Request

Get all tokens

HTTP Request

Delete token

HTTP Request

Change password

HTTP Request

Parameters

Change avatar

HTTP Request

Parameters

Categories

Get all categories

HTTP Request

Permission required

Query Parameters

active/deactive category

HTTP Request

Permission required

Parameters

Autocomplete categories

HTTP Request

Query Parameters

Create category

HTTP Request

Permission required

Parameters

Get additional information

HTTP Request

Export categories

HTTP Request

Permission required

Query Parameters

Get category

HTTP Request

Permission required

Update category

HTTP Request

Permission required

Parameters

Remove category

HTTP Request

Permission required

Cliente

Get all clientes

HTTP Request