api:mvs

Realiza o login retornando o token gerado

Path	{url_base}/api/v1/auth/signin
Tipo	POST
Corpo de Requisição
Tipo	JSON(application/json)
email	String(150), Obrigatório
password	String(20), Obrigatório
Exemplo	{ "email": "exemplo@email.com.br", "password": "12345678" }
Resposta
Tipo	JSON
Exemplo	{ "id": 1001, "email": "exemplo@email.com.br", "token": "eyJ1bmlxdWVfbmFtZSI6IlRoaWFnbyIsInN1YiI6Ij" }

Registra um novo usuário

Path	{url_base}/api/v1/auth/signup
Tipo	POST
Corpo de Requisição
Tipo	JSON(application/json)
name	String(100), Obrigatório
email	String(150), Obrigatório
password	String(20), Obrigatório
Exemplo	{ "name": "José Silva", "email": "exemplo@email.com.br", "password": "12345678" }
Resposta
Tipo	JSON
Exemplo	{ "id": 1001 }

Realiza o logout do usuário

Path	{url_base}/api/v1/auth/signout
Tipo	POST

Envia um e-mail com um token no link com expiração de 2 horas para o usuário registrar uma nova senha

Path	{url_base}/api/v1/forgot-password
Tipo	POST
Corpo de Requisição
Tipo	JSON(application/json)
email	String(150), Obrigatório
token	Text, Obrigatório
Exemplo	{ "email": "exemplo@email.com.br" }

Registra uma nova senha

Path	{url_base}/api/v1/reset-password
Tipo	POST
Corpo de Requisição
Tipo	JSON(application/json)
email	String(150), Obrigatório
Exemplo	{ "email": "exemplo@email.com.br", "token": "eyJ1bmlxdWVfbmFtZSI6IlRoaWFnbyIsInN1YiI6Ij" }

Registra um token.

Path	{url_base}/api/v1/ic/tokens
Tipo	POST
Cabeçário da Requisição
Authorization	Bearer {token usuário}
Resposta
Tipo	JSON
Exemplo	{ "id": 1001, "email": "exemplo@email.com.br", "token": "eyJ1bmlxdWVfbmFtZSI6IlRoaWFnbyIsInN1YAQSEFR" }

Recupera o token.

Path	{url_base}/api/v1/ic/tokens
Tipo	GET
Cabeçário da Requisição
Authorization	Bearer {token usuário}
Resposta
Tipo	JSON
Exemplo	{ "id": 1001, "token": "eyJ1bmlxdWVfbmFtZSI6IlRoaWFnbyIsInN1YAQSEFR" }

Registra a promoção.

Path	{url_base}/api/v1/ic/promotions
Tipo	POST
Cabeçário da Requisição
Authorization	Bearer {token IntelliCash}
Corpo de Requisição
Tipo	JSON(application/json)
erp_id	Inteiro(20), Obrigatório
document	String(20), Obrigatório
start_date	Date(Y/m/d), Obrigatório
finish_date	Date(Y/m/d), Obrigatório
barcode	String(30), Obrigatório
value	Decimal, Obrigatório
type	String(10), Obrigatório
qty_ticket	Integer, Obrigatório
qty_sales	Integer, Obrigatório
Exemplo	{ "erp_id": 1201, "document": "99999999999999", "start_date": "2019/07/21", "finish_date": "2019/07/30", "barcode": "7892222555215", "value": "2,3", "type": "abs", "qty_ticket": 10, "qty_sales": 10 }
Resposta
Tipo	JSON
Exemplo	{ "id": 3001 }

Recupera os clientes da promoção.

Path	{url_base}/api/v1/ic/promotions/customers?erp_id={erp_id}&store_document={store_document}
Tipo	GET
Cabeçário da Requisição
Authorization	Bearer {token IntelliCash}
Parâmetros do Path
Nome	Tipo	Descrição
{erp_id}	Inteiro(20)	Id da promoção no IntelliCash
{store_document}	String(20)	Documento da Loja que está lançou a promoção
Resposta
Tipo	JSON Array
Exemplo	[ { "name": "Julio Garcia", "document": "99999999999", "phone_number": "99999999999", "activation_date": "2019/07/21", "address": { "street": "Rua Cel. Joaquim Francisco", "number": 409, "district": "Varginha", "city": "Itajubá", "state": "MG" } } ]

Exclui a referencia do cliente para a sincronização dos clientes da promoção.

Path	{url_base}/api/v1/ic/promotions/customers?erp_id={erp_id}&store_document={store_document}&customer_document={customer_document}
Tipo	DELETE
Cabeçário da Requisição
Authorization	Bearer {token IntelliCash}
Parâmetros do Path
Nome	Tipo	Descrição
{erp_id}	Inteiro(20)	Id da promoção no IntelliCash
{store_document}	String(20)	Documento da Loja que está lançou a promoção
{customer_document}	String(20)	Documento do Cliente cadastrado na promoção

Registra um token.

Path	{url_base}/api/v1/mvs/tokens
Tipo	POST
Cabeçário da Requisição
Authorization	Bearer {token usuário}
Resposta
Tipo	JSON
Exemplo	{ "id": 1001, "email": "exemplo@email.com.br", "token": "eyJ1bmlxdWVfbmFtZSI6IlRoaWFnbyIsInN1YAQSEiT" }

Recupera o token.

Path	{url_base}/api/v1/mvs/tokens
Tipo	GET
Cabeçário da Requisição
Authorization	Bearer {token usuário}
Resposta
Tipo	JSON
Exemplo	{ "id": 1001, "token": "eyJ1bmlxdWVfbmFtZSI6IlRoaWFnbyIsInN1YAQSEiT" }

Registra a promoção.

Path	{url_base}/api/v1/mvs/promotions/{id}/customers
Tipo	POST
Cabeçário da Requisição
Authorization	Bearer {token MVS}
Parâmetros do Path
Nome	Tipo	Descrição
{id}	Inteiro(20)	Id da promoção
Corpo de Requisição
Tipo	JSON(application/json)
name	String(100), Obrigatório
document	String(20), Obrigatório
phone_number	String(30), Obrigatório
address	String(100), Obrigatório
district	String(100), Obrigatório
number	Integer, Obrigatório
city	String(60), Obrigatório
state	String(2), Obrigatório
activation_date	date(Y/m/d), Obrigatório
Exemplo	{ "name": "Paulo Moreiro", "document": "99999999999", "phone_number": "99999999999", "address": "Rua Cel. Joaquim Francisco", "district": "Varginha", "number": "409", "city": "Iatjubá", "state": "MG", "activation_date": "2019/07/22" }
Resposta
Tipo	JSON
Exemplo	{ "id": 4001 }

Registra a configuração mvs.

Path	{url_base}/api/v1/mvs/configs
Tipo	POST
Cabeçário da Requisição
Authorization	Bearer {token usuário}
Corpo de Requisição
Tipo	JSON(application/json)
access_token	Text, Obrigatório
url_promotion	String(200), Obrigatório
Exemplo	{ "access_token": "eyJ1bmlxdWVfbmFtZSI6IlRoaWFnbyIsInN1YAQSEiT" "url_promotion": "https://mvs.com.br/promotions", }
Resposta
Tipo	JSON
Exemplo	{ "id": 4001 }

Recupera as lojas.

Path	{url_base}/api/v1/stores
Tipo	GET
Cabeçário da Requisição
Authorization	Bearer {token usuário}
Resposta
Tipo	JSON
Exemplo	[ { "id": 1001, "user_id": 1031, "document": "99999999999999", "active": 1, "created_at": "2019-07-19 13:52:34" "updated_at": "2019-07-19 13:52:34" } ]

Recupera a loja informada.

Path	{url_base}/api/v1/stores/{id}
Tipo	GET
Cabeçário da Requisição
Authorization	Bearer {token usuário}
Parâmetros do Path
Nome	Tipo	Descrição
{id}	Inteiro(20)	Id da loja
Resposta
Tipo	JSON
Exemplo	{ "id": 1001, "user_id": 1031, "document": "99999999999999", "active": 1, "created_at": "2019-07-19 13:52:34" "updated_at": "2019-07-19 13:52:34" }

Registra ou atualiza a loja do usuário.

Path	{url_base}/api/v1/stores/{id}
Tipo	POST
Cabeçário da Requisição
Authorization	Bearer {token usuário}
Parâmetros do Path
Nome	Tipo	Descrição
{id}	Inteiro(20)	Id da loja. *Zero para uma nova loja
Corpo de Requisição
Tipo	JSON(application/json)
name	String(50), Obrigatório
document	String(20), Obrigatório
Exemplo	{ "name": "Loja 01" "document": "99999999999999", }
Resposta
Tipo	JSON
Exemplo	{ "id": 4001 }

Exclui um loja do usuário.

Path	{url_base}/api/v1/stores/{id}
Tipo	DELETE
Cabeçário da Requisição
Authorization	Bearer {token usuário}
Parâmetros do Path
Nome	Tipo	Descrição
{id}	Inteiro(20)	Id da loja

Recupera as promoções.

Path	{url_base}/api/v1/promotions
Tipo	GET
Cabeçário da Requisição
Authorization	Bearer {token usuário}
Resposta
Tipo	JSON
Exemplo	[ { "id": 1001, "store_id": 1031, "start_date": "2019-07-19", "finish_date": "2019-07-19", "barcode": "7892123456789", "value": 21, "type": "abs", "qty_ticket": 12, "qty_sales": 12 } ]

Recupera os clientes da promoção.

Path	{url_base}/api/v1/promotions/{id}/customers
Tipo	GET
Cabeçário da Requisição
Authorization	Bearer {token usuário}
Parâmetros do Path
Nome	Tipo	Descrição
{id}	Inteiro(20)	Id da promoção
Resposta
Tipo	JSON
Exemplo	[ { "id": 1001, "name": "João Almeida Neves", "document": "99999999999", "phone_number": "99999999999", "active": 1, "address": "Rua Cel. Joaquim Francisco", "district": "Varginha", "number": 409, "city": "Itajubá", "state": "MG", "activation_date": "2019-02-28", } ]

Recupera os logs da promoção.

Path	{url_base}/api/v1/mvs-export-logs/promotions
Tipo	GET
Cabeçário da Requisição
Authorization	Bearer {token usuário}
Resposta
Tipo	JSON
Exemplo	[ { "id": 1001, "store": "99999999999999", "start_date": "2019-07-19", "finish_date": "2019-07-22", "barcode": "78900151544442", "value": 33, "type": "abs", "qty_ticket": 21, "qty_sales": 13 } ]

Recupera os logs da MVs.

Path	{url_base}/api/v1/mvs-export-logs/logs
Tipo	GET
Cabeçário da Requisição
Authorization	Bearer {token usuário}
Resposta
Tipo	JSON
Exemplo	[ { "id": 1001, "url": "https:\\mvs.com.br/promotions", "request_body": {"promotion_id": 21, "start_date": "2019-02-11"}, "response_code": 200, "authorization": Bearer 78s1dsfsedFDVDFBAdddf, "created_at": "2019-07-19 13:52:34", "updated_at": "2019-07-19 13:52:34" } ]

Tabela de conteúdos

Lista de Operações

Autenticação

Signout

Recuperação de Senha

Esqueceu a senha

Nova senha

IntelliCash - Sincronizador

Gerar Token

Recuperar Token

Promoção

Promoção / Clientes

MVS

Gerar Token

Recuperar Token

Promoção / Clientes

Configuração

Loja

Recuperar Lojas

Recuperar Loja

Salvar loja

Excluir loja

Promoções

Recuperar promoções

Recuperar clientes da promoção

Logs

Logs Promoção

Logs Mvs

Tabela de conteúdos

Lista de Operações

Autenticação

Signin

Signup

Signout

Recuperação de Senha

Esqueceu a senha

Nova senha

IntelliCash - Sincronizador

Gerar Token

Recuperar Token

Promoção

Promoção / Clientes

MVS

Gerar Token

Recuperar Token

Promoção / Clientes

Configuração

Loja

Recuperar Lojas

Recuperar Loja

Salvar loja

Excluir loja

Promoções

Recuperar promoções

Recuperar clientes da promoção

Logs

Logs Promoção

Logs Mvs