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. |
Alerts
Get all my alerts
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/alerts",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/alerts
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 text max_value min_value created_at updated_at |
search | string | string | Search in the fields: uuid text |
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 alert
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/alerts/{alert}",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/alerts/{alert}
Create alert
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/alerts/new",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"text": "Repellat enim aperiam vitae quam velit omnis illum.",
"max_value": "Et molestiae odio labore iste illo fugit nihil.",
"min_value": "Saepe aut harum sapiente est consequuntur.",
"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/customer/alerts/new
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
text | string | required|string|max:191 | |
max_value | numeric | sometimes|nullable|numeric|min:1 | |
min_value | numeric | sometimes|nullable|numeric|min:1 | |
is_active | boolean | boolean | Default true |
Edit alert
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/alerts/edit/{alert}",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"text": "Officia deleniti ut perspiciatis mollitia distinctio qui autem.",
"max_value": "Recusandae possimus libero est.",
"min_value": "Iusto doloribus nihil harum eligendi libero quae.",
"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/customer/alerts/edit/{alert}
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
text | string | sometimes|nullable|string|max:191 | |
max_value | numeric | sometimes|nullable|numeric|min:1 | |
min_value | numeric | sometimes|nullable|numeric|min:1 | |
is_active | boolean | sometimes|nullable|boolean | Default true |
Remove alert
Example request:
const axios = require('axios');
axios({
"method": "delete",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/alerts/{alert}",
"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/customer/alerts/{alert}
Authentication
Login
5 login attempts can be performed every 1 minute.
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/auth/login",
"headers": {
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"email": "nadia.dominato@example.com",
"name": "Dr. Michele das Neves Jr.",
"avatar": "Cupiditate corrupti sunt repellat eaque labore.",
"password": "YY8yoGFVUy",
"login_external_id": "Dolorem quae ex atque quas illum consequatur modi labore.",
"network_external": "Aliquam impedit nihil sed similique.",
"token_name": "My Computer"
}
})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
{
"token_type": "Bearer",
"access_token": "eyJ0eXAiOiJ..."
}
HTTP Request
POST api/v1/customer/auth/login
No authentication required
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
string | sometimes|nullable|email | ||
name | string | required|string|max:50 | |
avatar | string | sometimes|nullable|string | |
password | string | sometimes|nullable|string|min:6 | |
login_external_id | string | sometimes|nullable|string|max:191 | |
network_external | string | sometimes|nullable|string|max:10 | Default: login-pass .Available values: facebook google apple |
token_name | string | required|string|max:191 | Client app name |
Password recovery
Send password reset link do user
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/auth/password/recovery",
"headers": {
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"email": "sdelvalle@example.org"
}
})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
{
"message": "Success message"
}
HTTP Request
POST api/v1/customer/auth/password/recovery
No authentication required
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
string | required|email |
Reset the given user's password.
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/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/customer/auth/password/reset
Create Account
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/customer/create",
"headers": {
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"email": "gabi14@example.net",
"name": "B\u00e1rbara Fidalgo Matos",
"login_external_id": "Et autem eos eligendi eligendi ut ut.",
"network_external": "Sed quas reprehenderit quia in blanditiis aut.",
"token_name": "My Computer",
"avatar": "Pariatur et eum quaerat voluptatem dolor.",
"password": "my_new_password",
"password_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/customer/customer/create
No authentication required
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
string | required|string|email|max:100 | ||
name | string | required|string|max:50 | |
login_external_id | string | sometimes|nullable|string|max:191 | |
network_external | string | sometimes|nullable|string|max:10 | Default: login-pass .Available values: facebook google apple |
token_name | string | sometimes|nullable|string|max:191 | Client app name |
avatar | string | sometimes|nullable|string | |
password | string | sometimes|nullable|string|min:6 | New password |
password_confirmation | string | sometimes|nullable|string|min:6 | Confirmation, must equal password |
Verify token send by email
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/customer/email/verify",
"headers": {
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"token": "Iste velit earum officiis illo dolorum architecto magni ex."
}
})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
{
"message": "message successfully"
}
HTTP Request
POST api/v1/customer/customer/email/verify
No authentication required
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
token | string | required|string|max:191 |
Resend token via email
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/customer/email/resend",
"headers": {
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"email": "desouza.denis@example.com"
}
})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
{
"message": "message successfully"
}
HTTP Request
POST api/v1/customer/customer/email/resend
No authentication required
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
string | required|string|email|max:100 |
Logout
Example request:
const axios = require('axios');
axios({
"method": "delete",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/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/customer/auth/logout
Get the authenticated user
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/auth/user",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/auth/user
Get all tokens
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/auth/tokens",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/auth/tokens
Delete token
Example request:
const axios = require('axios');
axios({
"method": "delete",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/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/customer/auth/tokens/{tokenId}
Delete account
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/auth/delete-account",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"password": "my_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/customer/auth/delete-account
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
password | string | sometimes|nullable|string|min:6 | my password |
Change password
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/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/customer/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 |
settings notify
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/auth/update/settings",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"notify_newsletter": "0",
"notify_offers": "1",
"notify_alerts": "0",
"notify_comments": "0",
"notify_likes": "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/customer/auth/update/settings
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
notify_newsletter | boolean | boolean | |
notify_offers | boolean | boolean | |
notify_alerts | boolean | boolean | |
notify_comments | boolean | boolean | |
notify_likes | boolean | boolean |
Update user
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/auth/update",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"name": "Everton Santiago Fontes",
"is_active": "0",
"city_id": "uuid"
}
})
.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/customer/auth/update
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
name | string | nullable|string|max:50 | |
is_active | boolean | boolean | |
city_id | string | nullable|string | City relationship |
Change avatar
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/auth/change-avatar",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"avatar": "{file}"
}
})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
{
"file_url": "{url}"
}
HTTP Request
POST api/v1/customer/auth/change-avatar
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
avatar | file | required|mimes:jpeg,png|max:4mb |
get all likes in offer
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/likes/offers",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/likes/offers
Query Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
limit | integer | integer | Default: 20 Max: 100 |
page | integer | integer |
Categories
Get all categories
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/categories",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/categories
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 created_at updated_at |
search | string | string | Search in the fields: uuid name |
Comments
Get profile user
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/comments/user/{customer}",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/comments/user/{customer}
Create denunciation
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/comments/denunciation",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"news_id": "eb5f713a-1183-33f7-bc44-d44397d0f6ac",
"offer_id": "72b930e5-25c6-333e-8ad7-a96e2dc2cdef",
"comment_id": "2dc537b7-924e-3166-9d8f-7d7ab731a8cc"
}
})
.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/customer/comments/denunciation
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
news_id | string | sometimes|nullable|string|max:191 | |
offer_id | string | sometimes|nullable|string|max:191 | |
comment_id | string | sometimes|nullable|string|max:191 |
Get all comments
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/comments",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/comments
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 created_at updated_at |
search | string | string | Search in the fields: uuid name |
Create comment
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/comments/new",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"offer_id": "008e0db9-cad3-37cd-bac9-26ec5c650357",
"new_id": "a63b65bf-0f64-3d41-90e6-f2f87888f527",
"parent_comment_id": "5cfacc20-78ed-3ed5-bbf8-c010cadf0f45",
"text": "Sua m\u00e3e \u00e9 uma grande sciencia; basta s\u00f3 isto de dar pancada ou prender voc\u00ea? Desculpe que eu fosse destemido, \u00e9 provavel que, com a visinha. N\u00e3o contou; fez apenas um gesto como indicando que havia no centro da casa ao p\u00e9: --Capit\u00fa! E no quintal: --Mam\u00e3e! E outra vez lhe contasse o que \u00e9 boa de mais; d\u00e1-lhe atten\u00e7\u00e3o de Capit\u00fa eram agora t\u00e3o retrahidas, que n\u00e3o me acho ridiculo; a adolescencia e a nossa familia, dizia elle, abaixo de Deus, consentiu; mas ou\u00e7a-me, j\u00e1 que falamos nisto, n\u00e3o \u00e9 de todo m\u00e1. Capit\u00fa, apesar daquelles olhos que lhe achei; mas \u00e9 s\u00f3 do ber\u00e7o que se perde em experimentar? Experimentemos; fa\u00e7a o que ainda agora a ac\u00e7\u00e3o do empenho, da palavra, da persuas\u00e3o lenta e diuturna, e examinasse antes as pessoas com quem podiamos contar. Rejeitou tio Cosme; Deus \u00e9 soberano. Um homem que estragava o chap\u00e9o em cortejar a visinhan\u00e7a, risonho, olhos no ar, antes mesmo da administra\u00e7\u00e3o interina. Vieram as semanas, a ferida sarou de todo. Com o fim arrependi-me do pedido: devia ter seguido o conselho de Capit\u00fa. Talvez abuso um pouco mais... Nisto ouvimos bater \u00e1 porta e falar no corredor. Era o que pergunto \u00e9 se voc\u00ea tem alguma cousa. Tive ideia de uma alma nova; eu proprio n\u00e3o me acudiram as for\u00e7as physicas e moraes, dava o ultimo surto da terra, e desta vez ca\u00eda em cima da cama. \u00abEsta \u00e9 a mesma cousa. Padua solicitava do sacrist\u00e3o uma das varas do pallio. A distinc\u00e7\u00e3o especial do pallio vinha de cobrir o vigario e o nariz. Ella afagou-me, depois quiz reprehender-me, mas creio que o senhor era \u00abum homem de capacidade e sabia opinar obedecendo. Ao cabo, era amigo, n\u00e3o direi optimo, mas nem tudo \u00e9 optimo neste mundo. E n\u00e3o lhe permittia acceitar mais doentes. --Mas, voc\u00ea curou das outras vezes; n\u00e3o p\u00f3de. Papae quer ver? E s\u00e9ria, fitou em mim os olhos escuros. Quando elles me clarearam, vi que Capit\u00fa recuou um pouco. Era occasi\u00e3o de pegal-a, puxal-a e beijal-a... Ideia s\u00f3 ideia sem lingua, que se devem incutir na alma do leitor, \u00e1 for\u00e7a de repeti\u00e7\u00e3o. Tambem ha."
}
})
.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/customer/comments/new
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
offer_id | string | sometimes|nullable|string|max:191 | |
new_id | string | sometimes|nullable|string|max:191 | |
parent_comment_id | string | sometimes|nullable|string|max:191 | |
text | string | required|string|max:10000 |
Get Comment
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/comments/{comments}",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/comments/{comments}
like or deslike comments
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/comments/like-deslike/{comments}",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"likedeslike": "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/customer/comments/like-deslike/{comments}
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
likedeslike | boolean | sometimes|nullable|boolean | Default true |
Edit comment
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/comments/edit/{comments}",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"text": "II: \u00abA sua m\u00e3o direita me abra\u00e7ar\u00e1 depois.\u00bb Vedes ahi a chronologia dos gestos. Era s\u00f3 executal-a; mas ainda assim, n\u00e3o creio que \u00e9 em desespero; negocio de relatorio. Voc\u00ea j\u00e1 viu o meu visinho Padua, que tambem ia \u00e1 missa, dizia-me sempre que era manifesta; os meus amores para lhe dizer que sim, porque ella veiu a alegria, um domingo, na figura de dous amigos, que iam jogar o solo, a tentos. J\u00e1 elle ria, j\u00e1 brincava, tinha o ar de ser padre, realmente \u00e9 melhor que elle disse que viesse jantar, afim de os pentear, se quizesse. --Voc\u00ea? --Eu mesmo. --Vae embara\u00e7ar-me o cabello todo, isso, sim. --Se embara\u00e7ar, voc\u00ea desembara\u00e7a depois. --Vamos ver. XXXIII O penteado. Capit\u00fa deu-me as costas, voltando-se para mim, e perguntou-me inquieta: --Que \u00e9 que hade ser? Primo Cosme n\u00e3o \u00e9, que n\u00e3o offendesse. E a prova \u00e9 que, apenas entrei na sala, pente, cabellos, toda ella voou pelos ares, e s\u00f3 lhe ouvi esta pergunta: --Ha alguma cousa? --N\u00e3o ha nada, respondi; vim ver voc\u00ea antes que o imperador socegado, replicou; fiquemos por ora com a amea\u00e7a da separa\u00e7\u00e3o; mas os annos viessem vindo. Entretanto, ia-me affei\u00e7oando \u00e1 ideia da morte se fosse var\u00e3o, mettel-o na egreja. Talvez esperasse uma menina. N\u00e3o disse mal della; ao contrario insinuou-me que podia tudo! que fazia tudo! Um homem p\u00f3de n\u00e3o ter gosto \u00e1 egreja e at\u00e9 a pirueta, que apenas lhe respondeu com um gesto inesperado, pousou a bocca entre-aberta, toda parada. Ent\u00e3o eu, para dar autoridade \u00e1 lic\u00e7\u00e3o, meio risonho para obter o perd\u00e3o da emenda. Ajudava assim o mestre de latim e precipitavamos as cerimonias. _Dominus, non sum dignus..._ Isto, que eu administrava... Tal \u00e9 o passar e repassar das memorias antigas. Ora, de todas as potencias christ\u00e3s e pag\u00e3s. Emfim, acabei as duas tran\u00e7as. Onde estava a recusar \u00e1 for\u00e7a. Repito, a alma \u00e9 cheia de mysterios. Agora sei que a escrava desconfiara, e ia pedir hostia por outro nome. Voltava com ella, Bentinho, disse minha m\u00e3e. Satisfil-a, attenuando o texto desta vez, para n\u00e3o sermos."
}
})
.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/customer/comments/edit/{comments}
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
text | string | required|string|max:10000 |
Remove comments
Example request:
const axios = require('axios');
axios({
"method": "delete",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/comments/delete/{comments}",
"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/customer/comments/delete/{comments}
Faq
Get all faq
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/faq",
"headers": {
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/faq
No authentication required
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 created_at updated_at |
search | string | string | Search in the fields: uuid name |
Get faq
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/faq/{faq}",
"headers": {
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/faq/{faq}
No authentication required
How It Works
Get all how it works
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/how-it-works",
"headers": {
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/how-it-works
No authentication required
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 created_at updated_at |
search | string | string | Search in the fields: uuid name |
Get how it works
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/how-it-works/{how_it_works}",
"headers": {
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/how-it-works/{how_it_works}
No authentication required
Institutional
About app
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/institutional/about-app",
"headers": {
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/institutional/about-app
No authentication required
About company
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/institutional/company-app",
"headers": {
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/institutional/company-app
No authentication required
Policy Cookies
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/institutional/policy-cookies",
"headers": {
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/institutional/policy-cookies
No authentication required
Privacy policy
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/institutional/privacy-policy",
"headers": {
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/institutional/privacy-policy
No authentication required
Terms of use
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/institutional/terms-of-use",
"headers": {
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/institutional/terms-of-use
No authentication required
News
Get all news
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/news",
"headers": {
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/news
No authentication required
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 schedule_at created_at updated_at |
search | string | string | Search in the fields: uuid title text |
Get news
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/news/{news}",
"headers": {
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/news/{news}
No authentication required
Notifications
Get all my notifications
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/notifications",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/notifications
Query Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
limit | integer | integer | Default: 20 Max: 100 |
page | integer | integer | |
is_alert | integer | integer | Available values: 0 1 |
orderBy | string | string | Default: id:asc .Available fields: id text max_value min_value 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 |
removed | string | string | string |
marca como lida uma push (usuário)
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/notifications/read/{uuid}",
"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/customer/notifications/read/{uuid}
marcar todas as minhas pushs (de usuario) como lido
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/notifications/all-read",
"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/customer/notifications/all-read
Remove uma push (usuário)
Example request:
const axios = require('axios');
axios({
"method": "delete",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/notifications/{uuid}",
"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/customer/notifications/{uuid}
exclui todas as minhas pushs (de usuario)
Example request:
const axios = require('axios');
axios({
"method": "delete",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/notifications",
"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/customer/notifications
Offers
Get all my offers
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/offers/my-offers",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/offers/my-offers
Query Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
limit | integer | integer | Default: 20 Max: 100 |
page | integer | integer | |
perfil_id | string | string|max:191 | |
category_id[] | array | sometimes|nullable|array|max:191 | |
under_review | integer | integer | Available values: 0 1 |
type | string | string | Available values: cupom oferta |
is_active | integer | integer | Available values: 0 1 |
store_id[] | array | sometimes|nullable|array|max:191 | |
orderBy | string | string | Default: id:asc .Available fields: id title price like shared comments offers_saves created_at updated_at |
search | string | string | Search in the fields: uuid title store |
created_at[0] | string | string | ISO 8601 Y-m-d\TH:i:sP Initial date |
created_at[1] | string | string | ISO 8601 Y-m-d\TH:i:sP Final date |
get all offer likes
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/offer-likes",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/offer-likes
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 price like shared comments offers_saves created_at updated_at |
search | string | string | Search in the fields: uuid title store |
get all offer save
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/offer-saves",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/offer-saves
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 price like shared comments offers_saves created_at updated_at |
search | string | string | Search in the fields: uuid title store |
Create offer
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/offers/new",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"title": "Nisi quia et sapiente similique quod.",
"store_id": "462724a7-8918-3371-96d7-8a38373c5bb3",
"category_id[]": "14bdda40-36a3-391c-94c2-a2099ae7250c",
"tags[]": "f85faf82-037c-30cb-b63e-8f7225cb69a0",
"perfil_id[]": "c5b34d3c-0054-3cf4-b71f-a01792af5c08",
"cupom": "Minus enim quae laboriosam et.",
"type": "'oferta'",
"discount_type": "'porcentagem'",
"link": "Nisi deleniti tempora nihil quas cumque sed.",
"price": "Et voluptates qui dolor tenetur voluptatum illo.",
"discount": "Est delectus sit provident quia porro illum qui.",
"is_active": "1"
}
})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
HTTP Request
POST api/v1/customer/offers/new
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
title | string | required|string|max:191 | |
store_id | string | required|string|max:191 | |
category_id[] | array | required|array|max:191 | |
tags[] | array | required|array | |
perfil_id[] | array | required|array|max:191 | |
cupom | string | sometimes|nullable|string|max:191 | |
type | string | string | Available values: cupom oferta |
discount_type | string | string | Available values: numerico porcentagem |
link | string | required|string|max:1500 | |
price | numeric | required|numeric|min:1 | |
discount | numeric | sometimes|nullable|numeric|min:1 | |
is_active | boolean | boolean | Default true |
Edit offer
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/offers/edit/{offer}",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"title": "Odio magni ut maiores qui explicabo.",
"store_id": "f9fa0620-4a96-37ec-89cf-9f3b1872932e",
"category_id[]": "ef3f5232-b589-317d-9383-e1fde958613e",
"tags[]": "bac34bfd-cb89-338f-86c9-41ca11d90205",
"cupom": "Iste unde voluptatem mollitia recusandae dolorem voluptatem deserunt.",
"link": "Natus error qui repellat ipsam.",
"type": "'oferta'",
"discount_type": "'porcentagem'",
"price": "Odit et cum modi alias dolores dolores.",
"discount": "Sit aliquid magnam alias quae.",
"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/customer/offers/edit/{offer}
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
title | string | sometimes|nullable|string|max:191 | |
store_id | string | sometimes|nullable|string|max:191 | |
category_id[] | array | required|array|max:191 | |
tags[] | array | required|array | |
cupom | string | sometimes|nullable|string|max:191 | |
link | string | sometimes|nullable|string|max:1500 | |
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 | |
is_active | boolean | sometimes|nullable|boolean | Default true |
like or remove like offer
likedeslike = true = like likedeslike = false = remove like
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/offers/like-deslike/{offer}",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"likedeslike": "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/customer/offers/like-deslike/{offer}
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
likedeslike | boolean | sometimes|nullable|boolean | Default true |
save offer
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/offers/save/{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
POST api/v1/customer/offers/save/{offer}
Remove Offer
Example request:
const axios = require('axios');
axios({
"method": "delete",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/offers/delete/{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/customer/offers/delete/{offer}
Get all offers
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/offers",
"headers": {
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/offers
No authentication required
Query Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
limit | integer | integer | Default: 20 Max: 100 |
page | integer | integer | |
perfil_id | string | string|max:191 | |
category_id[] | array | array|max:191 | |
type | string | string | Available values: cupom oferta |
under_review | integer | integer | Available values: 0 1 |
max_value | numeric | numeric|min:1 | static(1000) |
min_value | numeric | numeric|min:1 | static(100) |
is_active | integer | integer | Available values: 0 1 |
destaque | integer | integer | Available values: 0 1 |
store_id[] | array | array|max:191 | |
exclusive_app | boolean | boolean | Default true |
orderBy | string | string | Default: id:asc .Available fields: id title price like shared comments offers_saves created_at updated_at |
search | string | string | Search in the fields: uuid title store |
created_at[0] | string | string | ISO 8601 Y-m-d\TH:i:sP Initial date |
created_at[1] | string | string | ISO 8601 Y-m-d\TH:i:sP Final date |
Get offer
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/offers/{offer}",
"headers": {
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/offers/{offer}
No authentication required
shared offer
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/offers/shared/{offer}",
"headers": {
"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/customer/offers/shared/{offer}
No authentication required
On Sales
Get all on sales
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/on-sales",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/on-sales
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 |
terminated | 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 |
end_at | string | string | ISO 8601 Y-m-d\TH:i:sP Initial date |
created_at[0] | string | string | ISO 8601 Y-m-d\TH:i:sP Initial date |
created_at[1] | string | string | ISO 8601 Y-m-d\TH:i:sP Final date |
Get on sale
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/on-sales/{onsale}",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/on-sales/{onsale}
OnBoarding
Get all onboardings
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/onboarding",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/onboarding
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 |
Perfis
Get all perfil
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/perfis",
"headers": {
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/perfis
No authentication required
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 created_at updated_at |
search | string | string | Search in the fields: uuid name |
Get perfil
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/perfis/{perfil}",
"headers": {
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/perfis/{perfil}
No authentication required
Reports
Create report error
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/reports/error",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"offer_id": "befe967d-5564-3aed-99aa-3b761db8cc2f",
"text": "Todo esse discurso n\u00e3o me acudiu estender a m\u00e3o a minha unica affei\u00e7\u00e3o; desviava as suspeitas de cima de Capit\u00fa. Ent\u00e3o, como eu quizesse falar tambem para disfar\u00e7ar o meu futuro ecclesiastico, e queria saber se ia para o ar. Minto; ella olhava para."
}
})
.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/customer/reports/error
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
offer_id | string | required|string|max:191 | |
text | string | sometimes|nullable|string|max:255 |
Create report offer finish
Example request:
const axios = require('axios');
axios({
"method": "post",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/reports/finish-offer",
"headers": {
"Authorization": "Bearer {access_token}",
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json",
"Language": "{language}"
},
"data": {
"offer_id": "206f12cd-fb3e-3fa1-a190-3036ced7e8da"
}
})
.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/customer/reports/finish-offer
Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
offer_id | string | required|string|max:191 |
Settings General
Get settings
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/settings/general",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/settings/general
Permission required
settings-general.list
Stores
Get all stores
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/stores",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/stores
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 created_at updated_at |
search | string | string | Search in the fields: uuid name |
Stories
Get all groups stories
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/group-stories",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/group-stories
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 |
created_at[0] | string | string | ISO 8601 Y-m-d\TH:i:sP Initial date |
created_at[1] | string | string | ISO 8601 Y-m-d\TH:i:sP Final date |
Get all stories
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/stories",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/stories
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 |
groups_stories_id | array | sometimes|nullable|array|max:191 | |
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 Story
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/stories/{story}",
"headers": {
"Authorization": "Bearer {access_token}",
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/stories/{story}
Tags
Get all tag
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/tags",
"headers": {
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/tags
No authentication required
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 created_at updated_at |
search | string | string | Search in the fields: uuid name |
Get tag
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/tags/{tag}",
"headers": {
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/tags/{tag}
No authentication required
Webservice
Cities
Search city, must enter at least one of the search fields search
or state_abbr
List a maximum of 50
items.
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/webservice/cities",
"headers": {
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/webservice/cities
No authentication required
Query Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
search | string | string | Search in the fields: full_name |
state_abbr | string | string |
States
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/webservice/states",
"headers": {
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/webservice/states
No authentication required
Query Parameters
Parameter | Type | Validation | Description |
---|---|---|---|
search | string | string | Search in the fields: name |
Find zipcode
Example request:
const axios = require('axios');
axios({
"method": "get",
"url": "https://homologacao.clickweb.com.br:8445/api/v1/customer/webservice/zipcode/{zipcode}",
"headers": {
"Accept": "application/json",
"Language": "{language}"
}})
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
.finally(function () {
// optional, always executed
});
Example response:
null
HTTP Request
GET api/v1/customer/webservice/zipcode/{zipcode}