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": "Et architecto ex sequi vel ex molestias.",
        "max_value": "Quasi ex et repellat est perspiciatis corrupti vel.",
        "min_value": "Beatae et temporibus iure vel.",
        "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": "Iusto omnis doloremque neque facere sit nemo aperiam.",
        "max_value": "Repudiandae fuga ad ipsam vero.",
        "min_value": "Magnam explicabo aut minima accusantium minus.",
        "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": "mascarenhas.sueli@example.org",
        "name": "Juan Arag\u00e3o Pontes",
        "avatar": "Debitis voluptates qui consequatur sed quam recusandae sit voluptas.",
        "password": "gll4u6AMAk",
        "login_external_id": "Eveniet eius et rerum.",
        "network_external": "Deserunt neque dolorum voluptate voluptatem qui.",
        "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
email	string	required|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": "rdias@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": "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.

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": "hosana34@example.org",
        "name": "Sra. Julieta Galindo Filho",
        "login_external_id": "Et culpa iste magni aspernatur in doloremque.",
        "network_external": "Rem numquam dicta recusandae repellat aut eum voluptatem.",
        "token_name": "My Computer",
        "avatar": "Amet libero et praesentium labore error ut.",
        "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

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": "Dolorem doloribus ducimus nam accusamus doloribus et."
}
})
.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": "kgomes@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": "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

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": "0",
        "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": "Stella Faria Aranda Neto",
        "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/auth/update

Parameters

Parameter	Type	Validation	Description
name	string	nullable|string|max:50
is_active	boolean	boolean

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": {
        "offer_id": "7faa2b6d-995e-32bc-acac-8f1d1b5c1c33",
        "comment_id": "8be9b249-209d-3bd3-a582-91272d5fd2a0"
}
})
.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
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": "9c0ccbc3-d469-3ff4-a796-0a62ed818bca",
        "new_id": "dfb5e56a-af5d-3b3b-9ed5-f40f4d62f3b8",
        "parent_comment_id": "bfe76783-d003-3abf-a8d3-a4335f4221d2",
        "text": "Capit\u00fa era Capit\u00fa, isto \u00e9, uma creatura mui particular, mais mulher do que mam\u00e3e quizer. --Prima Gloria p\u00f3de ser que mude de resolu\u00e7\u00e3o; se n\u00e3o approvava a minha amiga; pelo que, n\u00e3o admira que, combatendo os meus pluraes careciam, alguma vez, da desinencia exacta, elle a um sujeito, em minha casa, prestava mais alten\u00e7\u00e3o que d'antes, e, segundo era louvor ou critica, assim me trazia arrepios, e me atirasse a ella com mil palavras callidas e mimosas... N\u00e3o mofes dos meus actos; mas concluo que sim, que iria falar a D. Gloria, afinal, n\u00e3o pode gostar disto. A gente Padua n\u00e3o \u00e9 bonito que voc\u00ea goste tambem. Papae est\u00e1 bom? E mam\u00e3e? A voce n\u00e3o se p\u00f3de? --P\u00f3de-se. --Pois ent\u00e3o! exclamou Jos\u00e9 Dias curou o feitor e uma grande opera. O tenor e o queixo largo. As m\u00e3os, unindo os nervos, faziam das duas creaturas uma s\u00f3, mas uma s\u00f3 hora. Um beijo e f\u00e9rias! Creio que Jos\u00e9 Dias tratava-me com extremos de m\u00e3e e atten\u00e7\u00f5es de servo. Jos\u00e9 Dias desculpava-se: \u00abSe soubesse, n\u00e3o teria falado, mas falei pela venera\u00e7\u00e3o, pela estima, pelo affecto, para cumprir a vontade aqui foi antes uma ideia, uma ideia fantastica, a ideia de ambos. N\u00e3o me lembra nada delle, a n\u00e3o sermos n\u00f3s, j\u00e1 teria voltado para l\u00e1; tinha amigos em Lisboa, mas a mulher gastava pouco, e a adula\u00e7\u00e3o. Oh! a adula\u00e7\u00e3o! D. Fortunata foi um aviso para que elle disse que voc\u00ea se ordene, mas ainda d\u00e1 ideia daquella fei\u00e7\u00e3o nova. Traziam n\u00e3o sei se diga com amor. Um dia fui achal-a desenhando a lap\u00eds um retraio; dava os ultimos rasgos, e pediu-me que outra cousa, um perfil, que disse ser o calix, e expoz-me a historia da crea\u00e7\u00e3o, com palavras que s\u00f3 vim a apprender equita\u00e7\u00e3o mais tarde, vim a saber mais tarde. J\u00e1 ent\u00e3o namorava o piano da nossa casa, velho traste inutil, apenas de estima\u00e7\u00e3o. Lia os nossos livros de gravuras, querendo saber das ruinas, das pessoas, das campanhas, o nome, n\u00e3o sei que balsamo interior. \u00c1s vezes dava por mim, sim? Voc\u00ea quer, Bentinho? --Mam\u00e3e querendo. --Quero, meu filho. Sua Majestade manda. Ent\u00e3o."
}
})
.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": "Minha m\u00e3e esperou que eu fosse a vaidade das crian\u00e7as, foi que a tinha. \u00abO desuso \u00e9 que hade ser? Primo Cosme n\u00e3o enriquecia no f\u00f2ro: ia comendo. Tinha o escriptorio na antiga rua das Violas, perto do jury, que era mentira e fiquei assim pasmado e tremulo. Era a primeira que lhe achei; mas \u00e9 tambem exacto que perdeu muito espinho que a delle. Assim, quando minha m\u00e3e novamente pegou em mim, descrevendo o meu gaturamo? Est\u00e1 alli no fundo. Ia agora mesmo buscar a gaiola; ande ver. Que o meu homem. Era a primeira que lhe achei; mas \u00e9 in\u00fatil... Vamos, \u00e9 tarde; vamos para a Escriptura, dizia que com o nosso namoro; se ella me passava a m\u00e3o esquerda se p\u00f4z j\u00e1 debaixo da minha vara; e, como j\u00e1 conhecia a viola\u00e7\u00e3o de Lucrecia. Dos romanos apenas sabia que fizesse; e outra vez a interinidade interrompida; o administrador regressava ao antigo cargo... Quiz ceder-lhe a vara; lembrou-me que elle deixasse o quarto da chacara; ao setimo dia, depois da meia noite, e que o libretto foi sacrificado, que a familia Padua perdeu tanta cousa; d'ahi vieram as nossas rela\u00e7\u00f5es. Pois eu hei de mentir nem faltar, Bentinho; s\u00e3o cousas que n\u00e3o v\u00ea; tomara elle que as velhas escravas me contavam de promessas celebres, 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 omnibus. XXIX O imperador. Em caminho, encontr\u00e1mos o imperador, todo risonho, sem entrar na sala penteando o cabello, disse-me; v\u00e1 devagarzinho para lhe dizer isto, mas n\u00e3o passou do gesto; estava amuado. No dia seguinte fui \u00e1 janella, esperando que ella chorou muito; mas a optima dellas \u00e9 nenhuma. Capit\u00fa era Capit\u00fa, isto \u00e9, que n\u00e3o entend\u00ed bem nem mal. Capit\u00fa segredou-me que a difficuldade estava na antiga rua das Violas, perto do jury, que era advogado, confiava-lhe a copia de papeis de autos. VI Tio Cosme. Tio Cosme viu exal\u00e7ar-se no parceiro de voltarete, e repetia: --Protonotario."
}
})
.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

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
is_active	integer	integer	Available values: 0 1
under_review	integer	integer	Available values: 0 1
type	string	string	Available values: cupom oferta
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": "multipart/form-data",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "title": "Est enim expedita voluptatem officiis vel.",
        "store_id": "450a12f6-5632-3c12-bffe-a43af76d5db0",
        "category_id[]": "fd73b765-5e6a-3acc-852a-b818dbe37d3f",
        "type": "'oferta'",
        "discount_type": "'porcentagem'",
        "link": "Non perferendis hic nesciunt.",
        "price": "Illo animi numquam sit vel laudantium nostrum.",
        "discount": "Saepe dolores et iure enim recusandae nihil perspiciatis.",
        "is_active": "1",
        "images[]": "{file}"
}
})
.then(function (response) {
    // handle success
    console.log(response);
})
.catch(function (error) {
    // handle error
    console.log(error);
})
.finally(function () {
    // optional, always executed
});

HTTP Request

POST api/v1/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
type	string	string	Available values: cupom oferta
discount_type	string	string	Available values: numerico porcentagem
link	string	required|string|max:191
price	numeric	required|numeric|min:1
discount	numeric	sometimes|nullable|numeric|min:1
is_active	boolean	boolean	Default true
images[]	file	nullable|array|mimes:jpg,jpeg,png|max:4mb

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": "multipart/form-data",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "title": "Fugiat earum ipsam rerum aut placeat eos eum.",
        "store_id": "df3258ec-d1df-3d5c-8662-2a9679cd6742",
        "category_id[]": "87bfe1f8-451b-3a50-bbe5-9293783eb0c4",
        "link": "Suscipit autem dolorem voluptas repellat vel.",
        "type": "'oferta'",
        "discount_type": "'porcentagem'",
        "price": "Velit rerum neque quae aut quia illum.",
        "discount": "Qui voluptas quo quo itaque eius quia voluptatem.",
        "is_active": "0",
        "images": "{file}",
        "images_delete[]": "3857cb86-210f-3ca8-9ec9-9c5b2163fefb"
}
})
.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
link	string	sometimes|nullable|string|max:191
type	string	sometimes|nullable|string	Available values: cupom oferta
discount_type	string	sometimes|nullable|string	Available values: numerico porcentagem
price	numeric	sometimes|nullable|numeric|min:1
discount	numeric	sometimes|nullable|numeric|min:1
is_active	boolean	sometimes|nullable|boolean	Default true
images	file	nullable|array|mimes:jpg,jpeg,png|max:4mb
images_delete[]	array	required|array|max:191

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
is_active	integer	integer	Available values: 0 1
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_exclusive_app	boolean	boolean	static(1) Available values: 0 1
is_internacional	boolean	boolean	static(1) Available values: 0 1
free_shipping	boolean	boolean	static(1) Available values: 0 1
store_id[]	array	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 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": {
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "offer_id": "34c74465-b12a-3155-804d-c62fad56480c",
        "text": "No principio era o _d\u00f3_, e o homem dos momentos graves, como era \u00e1 rua, pelo homem dobradi\u00e7o e inquieto. Mexia-se todo, falava de tudo, fazia-me parar a cada passo deante de um projecto que \u00e9, al\u00e9m de promessa, a ambi\u00e7\u00e3o e o homem tezo rendeu o."
}
})
.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

No authentication required

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": {
        "Content-Type": "application/x-www-form-urlencoded",
        "Accept": "application/json",
        "Language": "{language}"
    },
    "data": {
        "offer_id": "e46044f1-4eaa-3a99-b03d-f3a5c05773dd"
}
})
.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

No authentication required

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}

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}

No authentication required