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": "Id enim porro vitae corporis.",
"max_value": "Porro facere dolor deserunt eos deleniti.",
"min_value": "In est natus laboriosam sunt neque consequuntur.",
"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/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": "Architecto dolores quae est tenetur vel vel.",
"max_value": "Eum nam possimus nobis qui et sapiente repellat non.",
"min_value": "Tenetur reiciendis corporis iste laudantium.",
"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/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": "miranda.pereira@example.org",
"name": "Lav\u00ednia Dominato Neto",
"avatar": "Ea consequatur architecto neque ratione aut suscipit et aut.",
"password": "b9nn40Yw3a",
"login_external_id": "Voluptatibus vel at illum sit odit.",
"network_external": "Iure consequatur voluptatem totam quidem accusamus repellendus laboriosam nulla.",
"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": "hernani.vega@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": "aragao.artur@example.net",
"name": "Sr. Fl\u00e1vio Davi Domingues Jr.",
"login_external_id": "Eaque suscipit velit quae et aspernatur.",
"network_external": "Quis dolor numquam dolore consequatur soluta dignissimos nesciunt.",
"token_name": "My Computer",
"avatar": "Quae velit sint corrupti magnam distinctio voluptatem et.",
"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": "Sed iusto minus consectetur ea est."
}
})
.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": "estrada.kauan@example.net"
}
})
.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": "1",
"notify_offers": "0",
"notify_alerts": "1",
"notify_comments": "1",
"notify_likes": "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/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": "Daniela Delatorre Cruz Sobrinho",
"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": "f5db1840-3eec-3738-85b6-b0accdc8f0dc",
"offer_id": "59533211-e7a4-3ab8-b5ee-581107e40e58",
"comment_id": "738ec9b1-984b-3ef6-8d84-fc62f296bf96"
}
})
.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": "86a04bef-8668-36be-a471-17294476bba2",
"new_id": "c8ba32fc-e405-326d-abb4-dd0811e73caa",
"parent_comment_id": "ab92bab0-9b55-3609-ac9b-d7955d2ac723",
"text": "Capit\u00fa; dir\u00e1 agora outra cousa. Elle gosta muito de voc\u00ea. N\u00e3o lhe fale acanhado. Tudo \u00e9 que \u00e9 boa de mais; d\u00e1-lhe atten\u00e7\u00e3o de mais. Parece at\u00e9 que chorou. --Jos\u00e9 Dias? --N\u00e3o, mam\u00e3e. --Chorou porque? --N\u00e3o sei; ouvi s\u00f3 dizer que n\u00e3o tinha voca\u00e7\u00e3o.... --Posso confessar? --Pois, sim, mas eu sentia a secreta esperan\u00e7a de vel-a atirar-se a mim mesmo, e logo perdia tudo para a desgra\u00e7a dos outros; mas tambem, pedir outra cousa, mette-se ent\u00e3o o imperador fizera muito bem trabalhar por mim, voltou e, abafando a voz, disse que o pae de Capit\u00fa, mas ent\u00e3o com as m\u00e3os \u00e1 natureza. Formado para as serenas funcc\u00f5es do capitalismo, tio Cosme que a puxava; a cabe\u00e7a n\u00e3o as rege por meio de uma situa\u00e7\u00e3o que me fizesse dar a outros anjos que acabavam de nascer. Em todos esses sonhos andavamos unidinhos. Os que eu quero \u00e9 que n\u00e3o comece a dizer nada; ainda que nos velhos livros. Passaros, borboletas, uma cigarra que ensaiava o estio, toda a cara, todo a pessoa, todo o mundo pareciam rir nelle. Nos lances graves, gravissimo. Era nosso aggregado desde muitos annos; meu pae propoz-lhe ficar alli vivendo, com pequeno ordenado. Jos\u00e9 Dias sorriu sem vexame. Padre Cabral retorquia: --A voca\u00e7\u00e3o \u00e9 que n\u00e3o se pergunta; essa cara \u00e9 mesmo de quem vende saude. E como havia de prender. Valha-me Deus! vi de imagina\u00e7\u00e3o o aljube, uma casa escura e infecta. Tambem vi a presiganga, o quartel dos Barbonos e a sensa\u00e7\u00e3o do beijo. Podiam ser mentira ou illus\u00e3o. Sendo verdade, eram os seus? Que ella tambem ia acompanhar o Santissimo. Deu comnosco, veiu comprimentar-nos. Jos\u00e9 Dias recusou, dizendo que os velhos poetas me apresentaram depois; mas, desejei penteal-os por todos os impulsos da edade e uma viuva quarentona n\u00e3o havia logar para ciumes. \u00c9 certo que, ap\u00f3s algum tempo, vinha apregoando cocadas, parou em frente e perguntou: --Sinh\u00e1sinha, qu\u00e9 cocada hoje? --N\u00e3o, respondeu Capit\u00fa. --Cocadinha t\u00e1 boa. --V\u00e1-se embora, replicou ella sem rispidez. --D\u00ea ca! disse eu depois de me dar um passo no caminho da."
}
})
.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": "Quanto \u00e1s amigas, algumas datam de quinze annos, outras de proposito, levado de um e do pensamento israelita. Catei os proprios vermes dos livros, para que nos esperava, mas o padre Cabral. Voc\u00ea n\u00e3o se podendo calcular em que o final do penteado da manh\u00e3 era um espelhinho de pataca (perdoai a barateza), comprado a um mascate italiano, moldura tosca, argolinha de lat\u00e3o, pendente da parede, entre as duas trancas. N\u00e3o as fiz logo, nem assim ri. Ha cousas que me deixasse de molleza, que me fez crer nella. Talvez valha a pena dal-a; \u00e9 s\u00f3 um capitulo. Eram de varia especie, explicaveis e inexplicaveis, assim uteis como inuteis, umas graves, outras frivolas; gostava de mim; mas era t\u00e3o devota, t\u00e3o temente a Deus, que buscou testemunhas da obriga\u00e7\u00e3o, confiando a promessa antiga. --Prima Gloria deseja muito que lutar para separal-os. --N\u00e3o acho. Mettidos nos cantos? --\u00c9 um modo confuso. As partes orchestraes s\u00e3o ali\u00e1s tratadas com grande pericia. Tal \u00e9 a mesma da Rhenania; v\u00ea se deixas essa caverna do Engenho Novo, encontrei no trem da Central um rapaz aqui do bairro, que eu publicava pelo silencio. D. Fortunata foi um aviso para que nos velhos livros. Passaros, borboletas, uma cigarra que ensaiava o estio, toda a gente chegava \u00e1s janellas ou entravam nos corredores e se ajoelhavam \u00e1 nossa passagem, tudo me acudia sem se fixar de vez no espirito. Era muito longe, muito mar e muito tempo. Viva a medicina! Iria contar estas esperan\u00e7as a Capit\u00fa. --Parece que vae sair o Sant\u00edssimo, disse alguem no corredor; era D. Fortunata. Capit\u00fa compoz-se depressa, t\u00e3o depressa que, quando a m\u00e3e apontou \u00e1 porta, n\u00e3o ria. --J\u00e1 tinha rido das outras vezes; n\u00e3o p\u00f3de. Papae quer ver? E s\u00e9ria, fitou em mim e se ria, como se viesse j\u00e1 da porta fel-a olhar para Capit\u00fa, vi que era phenomeno recente accordar com o Padua na rua. --Mas eu n\u00e3o ria daquella vez por estar ao p\u00e9 de si, e antes parenta que extranha. Passe\u00e1mos alguns minutos na varanda, alumiada por um velho professor amigo do pae e."
}
})
.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": "Rem quia consequatur repellat minus maiores.",
"store_id": "e655d2d1-c2ba-3f99-93cf-33752977b146",
"category_id[]": "96735124-8d5e-383a-a613-2ed8f12dca33",
"tags[]": "771a2b4b-3f06-35fe-91a7-4feec415b72a",
"perfil_id[]": "d31ed985-5153-3e89-b6d4-bd3d0585f718",
"cupom": "Exercitationem in doloremque suscipit aut possimus recusandae.",
"type": "'oferta'",
"discount_type": "'porcentagem'",
"link": "Molestiae sit eos quod nobis corrupti.",
"price": "Id odio amet ea et.",
"discount": "Esse voluptate iure est ratione tempore.",
"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": "Aut accusantium aut consequatur tempora quia facere ipsa itaque.",
"store_id": "31b9f754-a924-32f2-895b-a648898b9d37",
"category_id[]": "04d05e2a-c028-3417-9586-ffb1bcc044f1",
"tags[]": "bc34cb9e-7449-3ada-90ec-2ce2e6d55819",
"cupom": "Maxime quo eaque sint doloremque.",
"link": "Saepe vitae hic quo quas illo repellendus.",
"type": "'oferta'",
"discount_type": "'porcentagem'",
"price": "Ut fugiat tenetur neque quibusdam eius aut ut.",
"discount": "Quo adipisci odit accusamus.",
"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/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": "81e2086c-4423-384e-bcd9-1ff248a1d41c",
"text": "Theresa. N\u00e3o choveu, mas eu n\u00e3o podia dizer. Novamente me intimou que ficasse, e retirou-se; eu deixei-me estar parado, pregado, agarrado ao ch\u00e3o. Afinal fiz um esfor\u00e7o, empurrei a porta, e uma escrava, e n\u00e3o durmo mal. Ora, como tudo can\u00e7a, esta."
}
})
.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": "ad0ceff7-0a59-35c0-9da1-97e7b6b85fbe"
}
})
.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}