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

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

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

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

null

HTTP Request

GET api/v1/customer/alerts/{alert}

Create alert

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": "Accusamus rem ut laborum expedita.",
        "max_value": "Ab commodi animi accusantium deleniti sed.",
        "min_value": "Sed omnis sed omnis mollitia fugiat et id architecto.",
        "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

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": "Quibusdam atque molestiae similique ut et.",
        "max_value": "Minus deserunt aut sed voluptatem.",
        "min_value": "Velit exercitationem dicta sed ratione rerum temporibus.",
        "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

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.

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": "galvao.andressa@example.net",
        "name": "Rodrigo Maia Salazar",
        "avatar": "Exercitationem aut aperiam modi non est doloremque.",
        "password": "Jj4bEJ7X10",
        "login_external_id": "Deserunt totam quasi sed.",
        "network_external": "Asperiores aperiam et ipsam aperiam architecto.",
        "token_name": "My Computer"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

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

HTTP Request

POST api/v1/customer/auth/login

No authentication required

Parameters

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

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

{
    "message": "Success message"
}

HTTP Request

POST api/v1/customer/auth/password/recovery

No authentication required

Parameters

Parameter	Type	Validation	Description
email	string	required\|email

Reset the given user's password.

const axios = require('axios');

axios({
    "method": "post",
    "url": "https://homologacao.clickweb.com.br:8445/api/v1/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

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": "barbara04@example.org",
        "name": "Dr. Camilo Deivid Carvalho Sobrinho",
        "login_external_id": "Omnis maxime in voluptatibus eos praesentium est facere.",
        "network_external": "Nesciunt eos illum voluptatum.",
        "token_name": "My Computer",
        "avatar": "Facilis qui nostrum ex neque qui quas.",
        "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
email	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

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": "Aut facere quasi corporis dolorum et cumque quis."
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

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

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": "julieta.fonseca@example.org"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

{
    "message": "message successfully"
}

HTTP Request

POST api/v1/customer/customer/email/resend

No authentication required

Parameters

Parameter	Type	Validation	Description
email	string	required\|string\|email\|max:100

Logout

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

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

null

HTTP Request

GET api/v1/customer/auth/user

Get all tokens

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

null

HTTP Request

GET api/v1/customer/auth/tokens

Delete token

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

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

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

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
notify_newsletter	boolean	boolean
notify_offers	boolean	boolean
notify_alerts	boolean	boolean
notify_comments	boolean	boolean
notify_likes	boolean	boolean

Update user

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": "Dr. Willian Natal Pacheco 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

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

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

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

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

Comments

Get profile user

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

null

HTTP Request

GET api/v1/customer/comments/user/{customer}

Create denunciation

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": "91289b93-d353-333e-b918-4ba608dfa744",
        "offer_id": "b1112f4d-c603-3f07-bfb3-bf5a31082e5d",
        "comment_id": "211c9d26-b47f-338b-a60e-fcf70a964c08"
}
})
.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
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

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

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

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": "50b128f2-1e46-33e5-913f-899f4ae593c7",
        "new_id": "594afd26-215e-384b-ae2d-3b95e205a432",
        "parent_comment_id": "c6950ff8-2cb1-32c7-af9a-efb98ed63dba",
        "text": "Com que ent\u00e3o eu amava Capit\u00fa, e Capit\u00fa a mim? Realmente, andava cosido \u00e1s saias de minha m\u00e3e, n\u00e3o attendia a cousa nenhuma. --N\u00e3o, minha senhora, n\u00e3o consentirei em tal vergonha! Fazer descer a familia, elle veiu tambem, e este applauso n\u00e3o lhe supponhas alma subalterna; as cortezias que fizesse vinham antes do calculo que da indole. A roupa durava-lhe muito; ao contrario das pessoas que tinham de entrar em scena, o accender das luzes, o preparo das rabecas, a symphonia... Agora \u00e9 que n\u00e3o fizesse caso, n\u00e3o era cousa rara nella, e conheciam-se as occasi\u00f5es pelo apertado dos olhos. Pediu-me algumas circumstancias mais, as proprias palavras de uns e de chap\u00e9o. Comprimentou-me, sentou-se ao p\u00e9 de cadeira lascado. Era pouco, mas distra\u00eda-me da afflic\u00e7\u00e3o. Quando tornei a olhar um para o padre Cabral foi porque o padre Cabral explicou que n\u00e3o podia dispensal-o. Tinha o dom de se lhe salvava o marido que se estenderam pouco a pouco, e vinha de cobrir o vigario e o prazer que sentia quando ella me consultar algum dia. Agora, ir falar-lhe sem ser chamada, n\u00e3o fa\u00e7o. XXII Sensa\u00e7\u00f5es alheias. N\u00e3o alcancei mais nada, se Deus n\u00e3o houvesse escripto um libretto de opera, do qual abrira m\u00e3o, por entender que tal genero de recreio era improprio da sua bocca.\u00bb E pelo que respeita aos bra\u00e7os, e valem de si mesma, emquanto que eu vim a saber mais tarde. Affirmou o principal, isto \u00e9, uma creatura mui particular, mais mulher do que trouxe a entrada aos dous.... Ande, pe\u00e7a, mande. Olhe; diga-lhe que est\u00e1 prompto a ser arredado um dia, n\u00e3o ha duvida; mas a doen\u00e7a era fatal, e elle n\u00e3o attendia a cousa nenhuma. --N\u00e3o, minha senhora, n\u00e3o consentirei em tal vergonha! Fazer descer a familia, elle veiu tambem, e ficassemos \u00e1 vontade, s\u00f3sinhos, at\u00e9 acabar o penteado, e sorriu por dissimula\u00e7\u00e3o... Como eu quizesse ir para o padre Cabral me ensinava latim, doutrina e obras de agulha, n\u00e3o apprendeu, por exemplo, n\u00e3o est\u00e1 no seminario e recebe a noticia das tribunas da Capella Imperial e dos."
}
})
.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
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

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

null

HTTP Request

GET api/v1/customer/comments/{comments}

like or deslike comments

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": "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/comments/like-deslike/{comments}

Parameters

Parameter	Type	Validation	Description
likedeslike	boolean	sometimes\|nullable\|boolean	Default true

Edit comment

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": "Jos\u00e9 Dias vinha andando cheio da leitura de Walter Scott que fizera \u00e1 Europa, e confessava que a difficuldade estava na casa de Capit\u00fa. Capit\u00fa preferia tudo ao seminario. Em vez de ir ao espelho, que pensaes que fez Capit\u00fa? N\u00e3o vos esque\u00e7aes quo estava sentada, de costas para mim. Capit\u00fa derreou a cabe\u00e7a, se o estomago, e apalpava-me a testa at\u00e9 \u00e1s dimens\u00f5es ordinarias: --Mas que posso eu fazer? perguntou. --P\u00f3de muito. O senhor sabe que, em rapaz, foi acceito de muitas voltas, a cara \u00e9 mesmo de tio Cosme. Era quem lhe metta isso na cabe\u00e7a. --Quem \u00e9? --Ora, quem! Quem \u00e9 que a dispensasse da promessa? --N\u00e3o, n\u00e3o quero perder \u00e9 a Europa; oh! a Europa... Levantou a perna e fez uma pirueta. Uma das minhas recorda\u00e7\u00f5es mais antigas era vel-o montar todas as injusti\u00e7as da terra e o sangue della. As proprias m\u00e3os tocadas, apertadas, como que lhe deix\u00e1ra uma impress\u00e3o aborrecida, Da toada n\u00e3o era; ao contrario, os adolescentes daquella edade n\u00e3o tinham outro officio, nem os cantos outra utilidade. Era um coqueiro velho, e eu \u00e9ramos pequenos. A porta n\u00e3o tinha cuidado em si... \u00c9 uma metaphora, n\u00e3o acho outra f\u00f3rma mais viva de dizer a missa nova, por um lampi\u00e3o. Quiz saber a conversa\u00e7\u00e3o da minha casa; eu contei-lh'a toda, menos a parte que lhe ficassem bem esticadas. A gravata de setim preto, com um \u00abOra!\u00bb que, traduzido em vulgar, queria dizer: \u00abS\u00e3o imagina\u00e7\u00f5es do Jos\u00e9 Dias: \u00abSempre juntos...\u00bb \u00abEm segredinhos...\u00bb \u00abSe elles pegam de namoro, a senhora podia pedir a minha m\u00e3e queria ter uma senhora uma perola do valor de seis milh\u00f5es de sestercios! --E quanto valia cada sestercio? Jos\u00e9 Dias, para se mostrar esquecido da propria gloria, mas era esta que o senhor est\u00e1 enganado. --P\u00f3de ser, minha senhora. Teve um pequeno discurso em honra \u00abao cora\u00e7\u00e3o paternal e augustissimo de Pio IX.\u00bb --Voc\u00ea \u00e9 um breve estribilho. N\u00e3o se esque\u00e7a que foram aquelles olhos de ressaca n\u00e3o se mostrou em nenhum dos musculos. Toda a cara livida, e rompeu nestas palavras furiosas: --Beata! carola!."
}
})
.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

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

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

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

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

null

HTTP Request

GET api/v1/customer/faq/{faq}

No authentication required

How It Works

Get all how it works

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

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

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

null

HTTP Request

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

No authentication required

Institutional

About app

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

null

HTTP Request

GET api/v1/customer/institutional/about-app

No authentication required

About company

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

null

HTTP Request

GET api/v1/customer/institutional/company-app

No authentication required

Policy Cookies

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

null

HTTP Request

GET api/v1/customer/institutional/policy-cookies

No authentication required

Privacy policy

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

null

HTTP Request

GET api/v1/customer/institutional/privacy-policy

No authentication required

Terms of use

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

null

HTTP Request

GET api/v1/customer/institutional/terms-of-use

No authentication required

News

Get all news

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

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

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

null

HTTP Request

GET api/v1/customer/news/{news}

No authentication required

Notifications

Get all my notifications

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

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)

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

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)

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)

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

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

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

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

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

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

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

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": "In illum est quam harum tempora dolore vitae.",
        "store_id": "64361586-b4f0-3f1d-adcd-0cbf5f89c853",
        "category_id[]": "984e562d-1a3a-3b22-95cb-c2506ef659f0",
        "tags[]": "ce5f8313-3011-33e2-9afa-75388e16bacc",
        "perfil_id[]": "9fd89490-c8e8-323a-b54e-4ac9fdd4c0f3",
        "cupom": "Maxime quidem aut ratione et corrupti ipsa.",
        "type": "'oferta'",
        "discount_type": "'porcentagem'",
        "link": "Qui quis voluptate dolorum rem voluptate.",
        "price": "Aut animi accusamus amet.",
        "discount": "Error animi omnis consequatur corrupti rerum autem in voluptatem.",
        "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/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

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": "Et repellat saepe aut omnis eos quasi rem.",
        "store_id": "64018d38-635d-3ea2-94da-7355afe7c3bc",
        "category_id[]": "f1daf4ab-b733-3c27-98f7-9d51a4198d15",
        "tags[]": "7dda3acf-0af0-3678-b6b2-a4d68cfbcf8d",
        "cupom": "Et non numquam voluptas unde magni.",
        "link": "Suscipit rem eligendi tempora et magnam doloribus.",
        "type": "'oferta'",
        "discount_type": "'porcentagem'",
        "price": "Sequi velit et est officia.",
        "discount": "Autem quidem ut eligendi in eveniet ducimus.",
        "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

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": "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/like-deslike/{offer}

Parameters

Parameter	Type	Validation	Description
likedeslike	boolean	sometimes\|nullable\|boolean	Default true

save offer

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

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

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

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

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

null

HTTP Request

GET api/v1/customer/offers/{offer}

No authentication required

shared offer

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

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

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

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

null

HTTP Request

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

OnBoarding

Get all onboardings

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

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

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

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

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

null

HTTP Request

GET api/v1/customer/perfis/{perfil}

No authentication required

Reports

Create report error

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": "00e37213-cd4e-3927-ba87-8b73e7df7948",
        "text": "Capit\u00fa ouvia-me com atten\u00e7\u00e3o sofrega, depois sombria; quando acabei, respirava a custo, como prestes a estalar de colera, mas conteve-se. Ha tanto tempo que n\u00e3o sae de l\u00e1. A pequena \u00e9 uma bonita carreira; mande-o para a egreja, o que contarei no outro."
}
})
.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

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": "0261a29a-a6f0-3a1b-8d32-4436ecef3666"
}
})
.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

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

null

HTTP Request

GET api/v1/customer/settings/general

Permission required

settings-general.list

Stores

Get all stores

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

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

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

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

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

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

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

null

HTTP Request

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

Webservice

Cities

Search city, must enter at least one of the search fields search or state_abbr
List a maximum of 50 items.

const axios = require('axios');

axios({
    "method": "get",
    "url": "https://homologacao.clickweb.com.br:8445/api/v1/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
});

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

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

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

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

null

HTTP Request

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

Introduction

Header

Controlling requests

Errors

Alerts

Get all my alerts

HTTP Request

Query Parameters

Get alert

HTTP Request

Create alert

HTTP Request

Parameters

Edit alert

HTTP Request

Parameters

Remove alert

HTTP Request

Authentication

Login

HTTP Request

No authentication required

Parameters

Password recovery

HTTP Request

No authentication required

Parameters

Reset the given user's password.

HTTP Request

Create Account

HTTP Request

No authentication required

Parameters

Verify token send by email

HTTP Request

No authentication required

Parameters

Resend token via email

HTTP Request

No authentication required

Parameters

Logout

HTTP Request

Get the authenticated user

HTTP Request

Get all tokens

HTTP Request

Delete token

HTTP Request

Delete account

HTTP Request

Parameters

Change password

HTTP Request

Parameters

settings notify

HTTP Request

Parameters

Update user

HTTP Request

Parameters

Change avatar

HTTP Request

Parameters

get all likes in offer

HTTP Request

Query Parameters

Categories

Get all categories

HTTP Request

Query Parameters

Comments

Get profile user

HTTP Request

Create denunciation

HTTP Request

Parameters

Get all comments

HTTP Request

Query Parameters