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": "Repudiandae similique enim quibusdam rerum aut ipsa vel dolor.",
        "file": "{file}",
        "file_mobile": "{file}",
        "video": "Animi rerum consectetur aut quia.",
        "text": "Voluptatem aspernatur et non quaerat. Ad atque sit similique dolores autem fugit. Sequi dolor tenetur unde nesciunt harum non. Dolores explicabo autem ab officiis necessitatibus consequatur."
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/about-app

Permission required

about-app.edit

Parameters

Parameter	Type	Validation	Description
name	string	string\|max:191
file	file	nullable\|mimes:jpg,jpeg,png\|max:4mb
file_mobile	file	nullable\|mimes:jpg,jpeg,png\|max:4mb
video	string	nullable\|url
text	string	nullable\|string\|max:60000	HTML allowed

About company

Get about company

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": "Itaque recusandae qui recusandae hic quas est.",
        "file": "{file}",
        "file_mobile": "{file}",
        "video": "Recusandae quia modi molestiae beatae quia nemo iure.",
        "text": "Blanditiis sit ut autem nisi perspiciatis et sequi. Nemo sunt itaque vitae sequi aliquid. Dolor temporibus eligendi eum ut et quae."
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/company-app

Permission required

about-company.edit

Parameters

Parameter	Type	Validation	Description
name	string	string\|max:191
file	file	nullable\|mimes:jpg,jpeg,png\|max:4mb
file_mobile	file	nullable\|mimes:jpg,jpeg,png\|max:4mb
video	string	nullable\|url
text	string	nullable\|string\|max:60000	HTML allowed

Authentication

Login

5 login attempts can be performed every 1 minute.

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": "silvana56@example.org",
        "password": "lVFZktabtZ",
        "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": "toledo.betina@example.com"
}
})
.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": "i3fl40MVZq",
        "password_confirmation": "my_new_password",
        "name": "Sunt fugit officiis est dolore quis a est.",
        "email": "dasdores.gabi@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

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": "y3SYtW8iMR",
        "password_confirmation": "my_new_password",
        "name": "Inventore reprehenderit recusandae quas porro asperiores earum.",
        "email": "noa85@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

active/deactive customer

const axios = require('axios');

axios({
    "method": "post",
    "url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/customers/active-desactive/{customer}",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "uuid": "88582e1c-b628-34de-a0ab-f1c4ffb4e87c",
        "is_active": "0"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/customers/active-desactive/{customer}

Permission required

customer.edit

Parameters

Parameter	Type	Validation	Description
uuid	string	string
is_active	boolean	boolean

Get all clientes deletedos

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

Comments

Get all comments

const axios = require('axios');

axios({
    "method": "get",
    "url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/comments",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

null

HTTP Request

GET api/v1/admin/comments

Permission required

comments.list

Query Parameters

Parameter	Type	Validation	Description
limit	integer	integer	Default: `20` Max: `100`
page	integer	integer
customer_id	string	string\|max:191
offer_id	string	string\|max:191
new_id	string	string\|max:191
orderBy	string	string	Default: `id:asc`. Available fields: `id` `name` `order` `created_at` `updated_at`
search	string	string	Search in the fields: `uuid` `name`

Get Comment

const axios = require('axios');

axios({
    "method": "get",
    "url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/comments/{comment}",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

null

HTTP Request

GET api/v1/admin/comments/{comment}

Permission required

comments.show

active/deactive comment

const axios = require('axios');

axios({
    "method": "post",
    "url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/comments/active-desactive/{comment}",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "uuid": "3c4edbe4-a66a-3125-9882-17c16ae8460b",
        "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/comments/active-desactive/{comment}

Permission required

comments.edit

Parameters

Parameter	Type	Validation	Description
uuid	string	string
is_active	boolean	boolean

Export comments

const axios = require('axios');

axios({
    "method": "get",
    "url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/comments/export",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

{
    "file_url": "{url}"
}

HTTP Request

GET api/v1/admin/comments/export

Permission required

comments.export

Query Parameters

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

Dashboard

Get summary of data

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": "7602d74b-32d7-36b2-9adb-78ca0d9d59fc",
        "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/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": "Ut temporibus nemo hic ullam quasi laborum.",
        "text": "Chamava-me \u00abum prodigio\u00bb; dizia a minha alma; era ao meu logar, trazia uma ideia fantastica, a ideia de ir pedil-o. E nada! E tornava \u00e1 tocha commum, outra vez lhe contasse o que disse, e atou o len\u00e7o outra vez andado, subimos ao terra\u00e7o, e olh\u00e1mos para o Rio de Janeiro com a mesma cousa. Padua solicitava do sacrist\u00e3o uma das suas ambi\u00e7\u00f5es era tornar \u00e1 Europa, falava della muitos vezes, sem acabar de tentar minha m\u00e3e a promessa a parentes e familiares. Unicamente, para que me doia, se a achardes digna das alturas, admitti-me com ella na vespera, antes e depois do ch\u00e1; logo... N\u00e3o \u00e9 raro que os dous seria o padre Cabral fala de ti com enthusiasmo. Caminhou para a desgra\u00e7a dos outros; mas tambem, pedir outra cousa, n\u00e3o pe\u00e7o. Se ella me consultar algum dia. Agora, ir falar-lhe sem ser chamada, n\u00e3o fa\u00e7o. XXII Sensa\u00e7\u00f5es alheias. N\u00e3o alcancei mais nada, e para traz. --No tempo em que nos apanhou. Era um velho professor amigo do pae e parceiro deste ao s\u00f3lo, mas n\u00e3o a mim. A mim \u00e9 que j\u00e1 sou meia mo\u00e7a, concluiu rindo. O riso animou-me. As palavras pareciam ser uma mo\u00e7a bonita. Eu, que j\u00e1 sou meia mo\u00e7a, concluiu rindo. O riso animou-me. As palavras pareciam ser uma tro\u00e7a comsigo mesma, uma vez que elles n\u00e3o lhe foi menos ao cora\u00e7\u00e3o que desta vez ia sair, com certeza, pela bocca de Jos\u00e9 Dias, obliquo e dissimulado; levantou o olhar, sem levantar os olhos. A voz, um tanto sumida, perguntou-me: --Diga-me uma cousa, mam\u00e3e... Mas, escute, olhe, \u00e9 melhor que padre s\u00f3 conego, por causa de uma alma que a trazia do ber\u00e7o e n\u00e3o ha falta de vontade, irei falar a Jos\u00e9 Dias pediu uma para si. --Ha s\u00f3 uma dispon\u00edvel, disse o que ainda agora a vista dos nossos nomes abertos por ella no muro, quiz fazer o officio de homem. Quando o sacrist\u00e3o come\u00e7ou a falar ao pae, que apertou a minha imagina\u00e7\u00e3o, assim como quem pede um copo de agua a pessoa que tem mam\u00e3e? --Mam\u00e3e quer que eu era administrador... Ou ent\u00e3o: --Ah! sim, lembra-me, foi antes uma ideia, uma ideia fantastica, a ideia de ir.",
        "order": 7,
        "is_active": "1"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/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": "Sit quasi optio cumque sed aut ut.",
        "text": "Minima molestiae reprehenderit aspernatur neque ducimus non id. Similique eius error accusantium voluptatem nemo beatae sapiente.",
        "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": "Aut non enim aspernatur quia consectetur earum eveniet soluta.",
        "order": 5,
        "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": "Iste esse ut libero beatae aut dolor itaque quia.",
        "text": "Repellendus quaerat neque sed repellendus deserunt temporibus dolorum quo. Aliquam nulla omnis eveniet similique deserunt iure ut. Numquam omnis magnam minus molestias laudantium.",
        "icon": "{file}",
        "order": 1,
        "is_active": "1"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/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": "Eum quia quae delectus numquam.",
        "text": "No dia seguinte entrou a cochilar e dormir. Tinhamos chegado \u00e1 janella; um preto, que, desde algum tempo, no corredor, quando iamos para o seminario e n\u00e3o achava gesto nem impeto que me envolvia em mim confesso que o coche parava \u00e1 nossa porta, o imperador apeava-se e entrava. Grande alvoro\u00e7o na visinhan\u00e7a: \u00abO imperador entrou em casa delle; ella iria \u00e1 minha. E colligindo os petrechos da costura, enfiou pelo corredor, e ouvi alguem dizer-me: --N\u00e3o chore assim! A imagem de Capit\u00fa ia respondendo promptamente e bem. Trazia um vestidinho melhor e os versos no bolso. --Continue, disse eu descendo o bra\u00e7o para receber duas. Comprei-as, mas tive de as comer s\u00f3sinho; Capit\u00fa recusou. Vi que, em meio da crise, a sensa\u00e7\u00e3o era um elogio. XXV No Passeio Publico. XXIV De m\u00e3e e ao padre. Como d\u00e9sse a este, duas vezes em cinco minutos, lembrou-me ir correndo \u00e1 casa do Engenho Novo, reproduzindo a de sempre. Capit\u00fa chamava-me \u00e1s vezes tinha, pegou do assumpto; o principal n\u00e3o \u00e9 para mostrar que Capit\u00fa tinha os olhos no ch\u00e3o. Ergueu-os logo, devagar, e fic\u00e1mos assim a olhar para mim, dizia-me, cheio de gra\u00e7a, bateu-me na casa de sap\u00e9 do pobre. --Quem lhe impede que v\u00e1 a outras partes? V\u00e1 aonde quizer, mas fique morando comnosco. --Voltarei daqui a tres mezes. Voltou dalli a duas semanas, acceitou casa e comida sem outro estipendio, salvo o que lhe dobrava a magnificencia, posto que, para ligal-o ao nome, era demasiado comprido; esta segunda reflex\u00e3o foi tio Cosme n\u00e3o enriquecia no f\u00f2ro: ia comendo. Tinha o dom de se consolar da tocha, da miseravel tocha. E comtudo havia outros que tambem sentia a nossa Escola.\u00bb E o publico? --Que publico, Sr. Padua? Deixe-se disso; seja homem. Lembre-se que sua mulher n\u00e3o tem Vintem, a modo que lhe posso valer, anjo do ceu? N\u00e3o hei de dissuadir sua m\u00e3e n\u00e3o quizer que eu lhe mandava; tambem n\u00e3o iam garridos, mas tambem eu precisava ser animado. Caimos no canap\u00e9, e fic\u00e1mos atrapalhados. Capit\u00fa foi ao muro, como se houvessem passado palavra, repeliam.",
        "order": 4,
        "is_active": "1"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

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

Permission required

how-it-works.create

Parameters

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

Get additional information

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": "Esse repudiandae est incidunt autem possimus laudantium optio.",
        "text": "Voluptas suscipit doloremque assumenda qui. Recusandae placeat eveniet minus voluptatem. Explicabo ullam quam architecto aliquid ea velit qui.",
        "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/{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": "34bb3859-83f4-346b-a87e-8341b8632b1d",
        "is_active": "1"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

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

Permission required

news.edit

Parameters

Parameter	Type	Validation	Description
uuid	string	string
is_active	boolean	boolean

Create news

const axios = require('axios');

axios({
    "method": "post",
    "url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/news",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "multipart/form-data",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "capa": "{file}",
        "title": "Impedit blanditiis accusamus hic fugit.",
        "link": "Consectetur odit nisi eius nostrum excepturi esse veniam suscipit.",
        "button": "Aut voluptatem quisquam id ut.",
        "text": "Maiores odit corporis quo. Ad esse eos perspiciatis cupiditate quisquam illo vel. Ut quod eos quae deserunt in commodi sit.",
        "scheduled_at": "2019-07-29T00:00:00-03:00",
        "is_active": "0"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/news

Permission required

news.create

Parameters

Parameter	Type	Validation	Description
capa	file	nullable\|mimes:jpg,jpeg,png\|max:4mb
title	string	required\|string\|max:191
link	string	required\|string\|max:300
button	string	required\|string\|max:191
text	string	nullable\|string\|max:60000
scheduled_at	string	string	ISO 8601 `Y-m-d\TH:i:sP` date
is_active	boolean	boolean

Autocomplete news

List a maximum of 50 items.

const axios = require('axios');

axios({
    "method": "get",
    "url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/news/autocomplete",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

null

HTTP Request

GET api/v1/admin/news/autocomplete

Query Parameters

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

Export news

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": "0ccef0ee-a5ad-3fd8-8e63-983690f43d34",
        "link": "Dolor repellendus dicta officiis ad explicabo asperiores.",
        "button": "Minus incidunt qui sed officia quos adipisci iure.",
        "title": "Quis voluptatem dolor culpa quaerat blanditiis sit.",
        "text": "Perspiciatis laborum dolore ut soluta deserunt porro iste. Non quo dolorum ipsam architecto.",
        "scheduled_at": "2019-07-29T00:00:00-03:00",
        "is_active": "1"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

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

Permission required

news.edit

Parameters

Parameter	Type	Validation	Description
capa	file	sometimes\|nullable\|mimes:jpg,jpeg,png\|max:4mb
capa_delete	string	sometimes\|nullable\|string\|max:191
link	string	required\|string\|max:300
button	string	required\|string\|max:191
title	string	sometimes\|nullable\|string\|max:191
text	string	sometimes\|nullable\|string\|max:60000
scheduled_at	string	sometimes\|nullable\|string	ISO 8601 `Y-m-d\TH:i:sP` date
is_active	boolean	sometimes\|nullable\|boolean

Remove news

const axios = require('axios');

axios({
    "method": "delete",
    "url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/news/{news}",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

DELETE api/v1/admin/news/{news}

Permission required

news.delete

api/v1/admin/verify/news/slug

const axios = require('axios');

axios({
    "method": "post",
    "url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/verify/news/slug",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/verify/news/slug

Get all news deleted

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
type	integer	integer	Available values: `cupom` `oferta`
under_review	integer	integer	Available values: `0` `1`
is_active	integer	integer	Available values: `0` `1`
store_id	string	string\|max:191
orderBy	string	string	Default: `id:asc`. Available fields: `id` `title` `price` `like` `shared` `comments` `created_at` `updated_at`
search	string	string	Search in the fields: `uuid` `name`
created_at[0]	string	string	ISO 8601 `Y-m-d\TH:i:sP` Initial date
created_at[1]	string	string	ISO 8601 `Y-m-d\TH:i:sP` Final date

Autocomplete stores

List a maximum of 50 items.

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": "Est iusto perferendis ea a in.",
        "store_id": "c90df045-8981-3572-b7ed-43186db6c7ca",
        "perfil_id[]": "e71591b5-90a2-3b25-8306-84805b3e66e0",
        "category_id[]": "f38e3fc1-6092-39c7-b15a-834c93d2704b",
        "link": "Possimus necessitatibus velit et cupiditate suscipit fugiat asperiores.",
        "cupom": "Tempora pariatur minus quia quibusdam doloremque.",
        "tags[]": "35cc4e4a-4f80-314b-b075-7c192523adbc",
        "type": "'oferta'",
        "discount_type": "'porcentagem'",
        "price": "Sed autem cupiditate earum nostrum et.",
        "discount": "Natus aperiam sint id et.",
        "sku": "Omnis et iure et minima dolorum consequatur aut dolorem.",
        "is_active": "1",
        "destaque": "0",
        "scheduled_at": "2019-07-29T23:59:59-03:00",
        "images[]": "{file}",
        "button_text": "2f0069cd-8da8-365e-8573-6258405bc4f0",
        "color_primary": "e3b27bf6-d6b3-3bf9-931b-08cab82d526d",
        "color_secundary": "0b33b9e7-dbac-32f0-926c-9b48c2f49e72"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/offers

Permission required

offers.create

Parameters

Parameter	Type	Validation	Description
title	string	required\|string\|max:191
store_id	string	required\|string\|max:191
perfil_id[]	array	required\|array\|max:191
category_id[]	array	required\|array\|max:191
link	string	required\|string\|max:1500
cupom	string	sometimes\|nullable\|string\|max:191
tags[]	array	required\|array
type	string	required\|string	Available values: `cupom` `oferta`
discount_type	string	sometimes\|nullable\|string	Available values: `numerico` `porcentagem`
price	numeric	sometimes\|nullable\|numeric\|min:1
discount	numeric	sometimes\|nullable\|numeric\|min:1
sku	numeric	required\|numeric\|min:1
is_active	boolean	boolean	Default true
destaque	boolean	boolean	Default true
scheduled_at	string	nullable\|string	ISO 8601 `Y-m-d\TH:i:sP` Future date
images[]	file	nullable\|array\|mimes:jpg,jpeg,png\|max:4mb
button_text	string	sometimes\|nullable\|string\|max:191
color_primary	string	sometimes\|nullable\|string\|max:7
color_secundary	string	sometimes\|nullable\|string\|max:7

Export offers

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": "Nihil consequuntur tempore ipsa velit eligendi est necessitatibus.",
        "perfil_id[]": "84621239-8469-3b67-bca3-ed97db4dd918",
        "store_id": "7996d3ac-fa96-3678-bc86-c26502457eb5",
        "category_id[]": "3b995e0d-4656-3e09-b47a-75259d333411",
        "link": "Libero beatae nemo sit.",
        "cupom": "Unde ipsam enim totam quasi vitae.",
        "tags[]": "b19ed443-e39f-3982-8105-cc3535ab3e8f",
        "type": "'oferta'",
        "discount_type": "'porcentagem'",
        "price": "Dolorem inventore facere quidem velit provident nulla aut.",
        "discount": "Et magni aut fugiat labore repudiandae.",
        "sku": "Aut earum accusamus debitis est possimus.",
        "is_active": "0",
        "destaque": "1",
        "scheduled_at": "2019-07-29T23:59:59-03:00",
        "resend_notification": "1",
        "under_review": "0",
        "images": "{file}",
        "imagens_no_delete[]": "20989ba5-e488-3fab-8797-685cbd7af9df",
        "button_text": "41dac34c-e035-3815-9010-0af5ea7ddbbb",
        "color_primary": "58f6ce7b-3fcd-3162-afcb-36d06874be73",
        "color_secundary": "bd11f669-8f51-3cc5-8805-20c828b9f9ef"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/offers/update/{offers}

Permission required

offers.edit

Parameters

Parameter	Type	Validation	Description
title	string	sometimes\|nullable\|string\|max:191
perfil_id[]	array	sometimes\|nullable\|array\|max:191
store_id	string	sometimes\|nullable\|string\|max:191
category_id[]	array	sometimes\|nullable\|array\|max:191
link	string	sometimes\|nullable\|string\|max:1500
cupom	string	sometimes\|nullable\|string\|max:191
tags[]	array	required\|array
type	string	sometimes\|nullable\|string	Available values: `cupom` `oferta`
discount_type	string	sometimes\|nullable\|string	Available values: `numerico` `porcentagem`
price	numeric	sometimes\|nullable\|numeric\|min:1
discount	numeric	sometimes\|nullable\|numeric\|min:1
sku	numeric	sometimes\|nullable\|numeric\|min:1
is_active	boolean	sometimes\|nullable\|boolean	Default true
destaque	boolean	sometimes\|nullable\|boolean	Default true
scheduled_at	string	nullable\|string	ISO 8601 `Y-m-d\TH:i:sP` Future date
resend_notification	boolean	sometimes\|nullable\|boolean	Default true
under_review	boolean	sometimes\|nullable\|boolean	Default true
images	file	sometimes\|nullable\|array\|mimes:jpg,jpeg,png\|max:4mb
imagens_no_delete[]	array	sometimes\|nullable\|array\|max:191
button_text	string	sometimes\|nullable\|string\|max:191
color_primary	string	sometimes\|nullable\|string\|max:7
color_secundary	string	sometimes\|nullable\|string\|max:7

Remove Offer

const axios = require('axios');

axios({
    "method": "delete",
    "url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/offers/{offers}",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

DELETE api/v1/admin/offers/{offers}

Permission required

offers.delete

api/v1/admin/verify/offers/slug

const axios = require('axios');

axios({
    "method": "post",
    "url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/verify/offers/slug",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/verify/offers/slug

Resend Notification

const axios = require('axios');

axios({
    "method": "post",
    "url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/offers/resendalert",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/offers/resendalert

Get all offers deleted

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`
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": "Magnam perspiciatis distinctio occaecati sit et optio.",
        "offer_id": "1bbd14a7-0aa1-32a8-b324-881ce6bf0f1f",
        "link": "Ducimus velit tenetur temporibus consectetur possimus.",
        "is_active": "0",
        "start_at": "2019-07-29T23:59:59-03:00",
        "end_at": "2019-07-29T23:59:59-03:00"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/on-sales

Permission required

on-sales.create

Parameters

Parameter	Type	Validation	Description
phrase	string	required\|string\|max:500
offer_id	string	required\|string\|max:191
link	string	required\|string\|max:191
is_active	boolean	boolean	Default true
start_at	string	nullable\|string	ISO 8601 `Y-m-d\TH:i:sP` Future date
end_at	string	nullable\|string	ISO 8601 `Y-m-d\TH:i:sP` Future date

Export on sales

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": "Consequatur sunt sint nam.",
        "offer_id": "412fda0b-8ea5-30f8-84c9-ab967d5a75aa",
        "link": "Esse consequuntur voluptas ut autem quisquam.",
        "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": "Ad ipsam rerum occaecati vel tenetur deserunt incidunt.",
        "frase2": "Earum rerum tenetur impedit odit possimus.",
        "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": "Id aut nam repudiandae magni qui officia.",
        "frase2": "In aut consequatur distinctio est qui similique nobis.",
        "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

Export onboarding

const axios = require('axios');

axios({
    "method": "get",
    "url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/onboarding/export",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

{
    "file_url": "{url}"
}

HTTP Request

GET api/v1/admin/onboarding/export

Permission required

onboarding.export

Query Parameters

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

Perfis

Get all perfil

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": "593bc687-4aa2-3207-a0ae-c7b060d6c931",
        "is_active": "0"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/perfis/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": "Consectetur qui voluptatem rem est.",
        "icon": "{file}",
        "order": 2,
        "is_active": "0"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/perfis

Permission required

perfis.create

Parameters

Parameter	Type	Validation	Description
name	string	required\|string\|max:191
icon	file	nullable\|mimes:jpg,jpeg,png\|max:4mb
order	integer	required\|integer
is_active	boolean	boolean	Default true

Get additional information

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": "Laboriosam est sint quos fuga voluptatibus consectetur.",
        "icon_delete": "257f8ecd-0142-3403-b1ca-1fa949df0dd4",
        "icon": "{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/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": "Culpa quidem consectetur quia eius.",
        "text": "Facilis mollitia et eligendi sed ducimus praesentium. Impedit vitae quia dicta necessitatibus est. Facilis distinctio repellendus quia quis sed et quam."
}
})
.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": "Eius est voluptates earum quia voluptates dolores mollitia.",
        "text": "Nihil recusandae fuga voluptatem incidunt. Dignissimos molestias ab et tempore et. Voluptate et nihil in est laborum."
}
})
.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": "Quos aut in dolorum sit.",
        "body": "Et odit voluptatem sed. Corporis sed est maiores inventore dolorem.",
        "url": "http:\/\/mendonca.com.br\/qui-porro-fugiat-occaecati-reprehenderit-et",
        "scheduled_at": "2019-07-29T23:59:59-03:00"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/push-city

Permission required

push-city.create

Parameters

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

Update push

const axios = require('axios');

axios({
    "method": "post",
    "url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/push-city/{push}",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "uuid": "uuid",
        "city_id": "2",
        "title": "Provident consectetur provident accusamus.",
        "body": "Ipsa commodi et culpa veritatis ducimus tempore quo. Minus sint aperiam ut quae possimus.",
        "url": "http:\/\/fonseca.com\/magni-autem-quisquam-unde-quibusdam-quos.html",
        "scheduled_at": "2019-07-29T23:59:59-03:00"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

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

Permission required

push-city.edit

Parameters

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

Export push

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": "Harum incidunt recusandae est.",
        "body": "Temporibus itaque quia esse. Et soluta aut rerum ipsum. Recusandae autem eum harum et quia.",
        "url": "http:\/\/mares.com.br\/neque-sunt-est-iure-quos-delectus-non-quisquam",
        "scheduled_at": "2019-07-29T23:59:59-03:00"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/push-general

Permission required

push-general.create

Parameters

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

Update push

const axios = require('axios');

axios({
    "method": "post",
    "url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/push-general/{push}",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "uuid": "uuid",
        "title": "Natus labore nesciunt sequi dolorem corrupti aut.",
        "body": "Beatae laborum repellat illo. Architecto nihil esse et nihil delectus error eius.",
        "url": "http:\/\/www.cruz.net.br\/nesciunt-aut-praesentium-voluptatibus-rerum-dignissimos",
        "scheduled_at": "2019-07-29T23:59:59-03:00"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

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

Permission required

push-general.edit

Parameters

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

Export push

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": "Consequatur at porro dolor quam et dolor.",
        "body": "Aut et id illum et. Rerum minus aut et qui. Possimus provident suscipit perspiciatis reiciendis.",
        "url": "http:\/\/solano.com\/labore-eaque-pariatur-voluptatem-et-autem-occaecati-perspiciatis.html",
        "scheduled_at": "2019-07-29T23:59:59-03:00"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/push-state

Permission required

push-state.create

Parameters

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

Update push

const axios = require('axios');

axios({
    "method": "post",
    "url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/push-state/{push}",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "uuid": "uuid",
        "state_id": "2",
        "title": "Aut nihil voluptas facilis veniam numquam.",
        "body": "Repellendus id modi nostrum cupiditate amet. Nemo provident qui aut perferendis ea velit.",
        "url": "http:\/\/matos.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-state/{push}

Permission required

push-state.edit

Parameters

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

Export push

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": "7fd1cdf9-06cd-3a6c-8eb8-11edec629364",
        "title": "Quia fuga odit optio corporis nam aliquid aut.",
        "body": "Est ut veniam blanditiis vero vitae velit. Aut sunt id ducimus aliquid.",
        "url": "https:\/\/www.delvalle.org\/mollitia-non-culpa-ipsam",
        "scheduled_at": "2019-07-29T23:59:59-03:00"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/push-user

Permission required

push-user.create

Parameters

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

Update push

const axios = require('axios');

axios({
    "method": "post",
    "url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/push-user/{push}",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "uuid": "uuid",
        "user_id": "74b24dc2-d68e-3d60-a58b-cf4da16a3578",
        "title": "Consectetur numquam deleniti quo optio culpa.",
        "body": "Deleniti dolorum quo dolorem. Molestias assumenda et autem cumque. Laboriosam animi qui dolorem.",
        "url": "https:\/\/www.santana.br\/et-nihil-aspernatur-aut",
        "scheduled_at": "2019-07-29T23:59:59-03:00"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

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

Permission required

push-user.edit

Parameters

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

Export push

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` `title` `name`
created_at[0]	string	string	ISO 8601 `Y-m-d\TH:i:sP` Initial date
created_at[1]	string	string	ISO 8601 `Y-m-d\TH:i:sP` Final date

Export report error

const axios = require('axios');

axios({
    "method": "get",
    "url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/reports/error/export",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

{
    "file_url": "{url}"
}

HTTP Request

GET api/v1/admin/reports/error/export

Permission required

reports-error.export

Query Parameters

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

Get report error

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

Export report finish

const axios = require('axios');

axios({
    "method": "get",
    "url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/reports/finish/export",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

{
    "file_url": "{url}"
}

HTTP Request

GET api/v1/admin/reports/finish/export

Permission required

reports-finish.export

Query Parameters

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

Get report offer finish

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": "Porro dolor laudantium ea. Expedita voluptatem impedit officiis voluptas nobis.",
        "permissions[0]": "cb2cebd7-e538-375a-adc7-95b17c651a7b"
}
})
.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": "Eaque distinctio impedit non est aut.",
        "description": "Libero vero autem nihil itaque. Asperiores commodi est necessitatibus est dolorum incidunt.",
        "permissions[0]": "b6e9ef29-d123-3399-91a0-e391bfcccfad"
}
})
.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",
        "whatsapp_group": "Magnam ullam qui est dolores.",
        "telegram_group": "Distinctio eius qui dolor.",
        "show_whatsapp": "1",
        "facebook": "Omnis ut fugit natus neque.",
        "instagram": "Officiis aut cupiditate enim ut voluptatem.",
        "telegram": "Veritatis molestiae quia quibusdam sit ut ut omnis excepturi.",
        "url_site": "Vero eos est ut repudiandae vero autem et.",
        "whatsapp_number": "(53) 91201-1058"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/settings/general

Permission required

settings-general.edit

Parameters

Parameter	Type	Validation	Description
app_url_android	string	nullable\|string\|url
app_url_ios	string	nullable\|string\|url
whatsapp_group	string	nullable\|string\|url
telegram_group	string	nullable\|string\|url
show_whatsapp	string	nullable\|boolean
facebook	string	nullable\|string\|url
instagram	string	nullable\|string\|url
telegram	string	nullable\|string\|url
url_site	string	nullable\|string\|url
whatsapp_number	integer	required\|string\|phone	Format `(99) 9999-9999` OR `(99) 99999-9999`

Settings Notifications

Get settings

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": {
        "delete_account[0]": "qmascarenhas@example.org",
        "create_account[0]": "jcolaco@example.com",
        "denunciation_comment[0]": "delgado.leia@example.org",
        "offer_error[0]": "aguiar.inacio@example.org",
        "offer_finish[0]": "otavio33@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
delete_account[]	array	array\|min:1
delete_account[0]	string	required\|email
create_account[]	array	array\|min:1
create_account[0]	string	required\|email
denunciation_comment[]	array	array\|min:1
denunciation_comment[0]	string	required\|email
offer_error[]	array	array\|min:1
offer_error[0]	string	required\|email
offer_finish[]	array	array\|min:1
offer_finish[0]	string	required\|email

Stores

Get all stores

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": "Harum occaecati possimus temporibus laboriosam sit ea voluptatibus.",
        "image": "{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/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": "Eligendi quos ea quia omnis.",
        "image": "{file}",
        "order": 5,
        "is_active": "0"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/admin/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": "Maxime ex mollitia rerum voluptatem in.",
        "groups_stories_id": "e28c8a40-7e03-34e4-b5bc-64d9e200755f",
        "midia": "{file}",
        "order": 1,
        "link": "Non consequatur amet illo quaerat consequuntur illo est.",
        "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

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": "Consectetur quos eligendi et.",
        "groups_stories_id": "714b9457-ba27-3ee2-8033-95a6d86c74a4",
        "midia": "{file}",
        "order": 4,
        "link": "Impedit sit non qui et molestias impedit repellat.",
        "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/{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

Export onboarding

const axios = require('axios');

axios({
    "method": "get",
    "url": "https://homologacao.clickweb.com.br:8445/api/v1/admin/stories/export",
    "headers": {
        "Authorization": "Bearer {access_token}",
        "Accept": "application/json",
        "Language": "{language}"
    }})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

{
    "file_url": "{url}"
}

HTTP Request

GET api/v1/admin/stories/export

Permission required

onboarding.export

Query Parameters

Parameter	Type	Validation	Description
date_start	string	static(2019-07-29T00:00:00-03:00)	8601 `Y-m-d\TH:i:sP`
date_end	string	static(2019-07-29T23:59:59-03:00)	8601 `Y-m-d\TH:i:sP`

System Log

Get all logs

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": "Aut qui dicta voluptatem id ut.",
        "text": "Deserunt ut repellendus laudantium similique delectus. Nihil dolorem quas at. Eum sint consequuntur doloremque ut. Suscipit nam qui velit officia. Dolore facilis amet ipsam et dolores illo."
}
})
.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. Elaine Fernanda Roque Filho",
        "password_random": "1",
        "password": "123456",
        "password_confirmation": "123456",
        "email": "wagner87@example.org",
        "is_active": "0",
        "roles[0]": "6275b457-afd1-360a-845b-bb753bfa5075"
}
})
.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]": "d8d0b11d-289c-3c63-83ae-04274e1e9bc3"
}
})
.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