Documentação de software

Essa página está em modo somente de leitura. Você pode visualizar a fonte, mas não alterá-la. Informe-se com o administrador do Wiki, caso você ache que isso está incorreto.
====== Lista de Operações ======

===== Autenticação =====

==== Signin ====

  * Realiza o login retornando o token gerado

<html>
<table>
      <tr>
        <td>Path</td>
        <td colspan="2">{url_base}/api/v1/auth/signin</td>
      </tr>
      <tr>
        <td>Tipo</td>
        <td colspan="2">POST</td>
      </tr>
      <tr>
        <td colspan="3">Corpo de Requisição</td>
      </tr>
      <tr>
        <td>Tipo</td>
        <td colspan="2">JSON(application/json)</td>
      </tr>
      <tr>
        <td>email</td>
        <td>String(150), Obrigatório</td>
      </tr>
      <tr>
        <td>password</td>
        <td>String(20), Obrigatório</td>
      </tr>
      <tr>
        <td>Exemplo</td>
        <td>
          <br>&emsp;{
          <br>&emsp;&emsp;"email": "exemplo@email.com.br",
          <br>&emsp;&emsp;"password": "12345678"
          <br>&emsp;}
        </td>
      </tr>
      <tr>
      <td colspan="3">Resposta</td>
    </tr>
    <tr>
      <td>Tipo</td>
      <td colspan="2">JSON</td>
    </tr>
    <tr>
      <td>Exemplo</td>
        <td>
          <br>&emsp;{
          <br>&emsp;&emsp;"id": 1001,
          <br>&emsp;&emsp;"email": "exemplo@email.com.br",
          <br>&emsp;&emsp;"token": "eyJ1bmlxdWVfbmFtZSI6IlRoaWFnbyIsInN1YiI6Ij"
          <br>&emsp;}
        </td>
    </tr>
    </table>
</html>

==== Signup ====

  * Registra um novo usuário

<html>
<table>
      <tr>
        <td>Path</td>
        <td colspan="2">{url_base}/api/v1/auth/signup</td>
      </tr>
      <tr>
        <td>Tipo</td>
        <td colspan="2">POST</td>
      </tr>
      <tr>
        <td colspan="3">Corpo de Requisição</td>
      </tr>
      <tr>
        <td>Tipo</td>
        <td colspan="2">JSON(application/json)</td>
      </tr>
      <tr>
        <td>name</td>
        <td>String(100), Obrigatório</td>
      </tr>
      <tr>
        <td>email</td>
        <td>String(150), Obrigatório</td>
      </tr>
      <tr>
        <td>password</td>
        <td>String(20), Obrigatório</td>
      </tr>
      <tr>
        <td>Exemplo</td>
        <td>
          <br>&emsp;{
          <br>&emsp;&emsp;"name": "José Silva",
          <br>&emsp;&emsp;"email": "exemplo@email.com.br",
          <br>&emsp;&emsp;"password": "12345678"
          <br>&emsp;}
        </td>
      </tr>
    <tr>
      <td colspan="3">Resposta</td>
    </tr>
    <tr>
      <td>Tipo</td>
      <td colspan="2">JSON</td>
    </tr>
    <tr>
      <td>Exemplo</td>
        <td>
          <br>&emsp;{
          <br>&emsp;&emsp;"id": 1001
          <br>&emsp;}
        </td>
    </tr>
    </table>
</html>

==== Signout ====

  * Realiza o logout do usuário

<html>
<table>
      <tr>
        <td>Path</td>
        <td colspan="2">{url_base}/api/v1/auth/signout</td>
      </tr>
      <tr>
        <td>Tipo</td>
        <td colspan="2">POST</td>
      </tr>
    </table>
</html>

===== Recuperação de Senha =====

==== Esqueceu a senha ====

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

<html>
<table>
      <tr>
        <td>Path</td>
        <td colspan="2">{url_base}/api/v1/forgot-password</td>
      </tr>
      <tr>
        <td>Tipo</td>
        <td colspan="2">POST</td>
      </tr>
      <tr>
        <td colspan="3">Corpo de Requisição</td>
      </tr>
      <tr>
        <td>Tipo</td>
        <td colspan="2">JSON(application/json)</td>
      </tr>
      <tr>
        <td>email</td>
        <td>String(150), Obrigatório</td>
      </tr>
      <tr>
        <td>token</td>
        <td>Text, Obrigatório</td>
      </tr>
      <tr>
        <td>Exemplo</td>
        <td>
          <br>&emsp;{
          <br>&emsp;&emsp;"email": "exemplo@email.com.br"
          <br>&emsp;}
        </td>
      </tr>
    </table>
</html>

==== Nova senha ====

  * Registra uma nova senha

<html>
<table>
      <tr>
        <td>Path</td>
        <td colspan="2">{url_base}/api/v1/reset-password</td>
      </tr>
      <tr>
        <td>Tipo</td>
        <td colspan="2">POST</td>
      </tr>
      <tr>
        <td colspan="3">Corpo de Requisição</td>
      </tr>
      <tr>
        <td>Tipo</td>
        <td colspan="2">JSON(application/json)</td>
      </tr>
      <tr>
        <td>email</td>
        <td>String(150), Obrigatório</td>
      </tr>
      <tr>
        <td>Exemplo</td>
        <td>
          <br>&emsp;{
          <br>&emsp;&emsp;"email": "exemplo@email.com.br",
          <br>&emsp;&emsp;"token": "eyJ1bmlxdWVfbmFtZSI6IlRoaWFnbyIsInN1YiI6Ij"
          <br>&emsp;}
        </td>
      </tr>
    </table>
</html>

===== IntelliCash - Sincronizador =====

==== Gerar Token ====

  * Registra um token.

<html>
<table>
      <tr>
        <td>Path</td>
        <td colspan="2">{url_base}/api/v1/ic/tokens</td>
      </tr>
      <tr>
        <td>Tipo</td>
        <td colspan="2">POST</td>
      </tr>
      <tr>
        <td colspan="3">Cabeçário da Requisição</td>
      </tr>
      <tr>
        <td>Authorization</td>
        <td colspan="2">Bearer {token usuário}</td>
      </tr>  
    <tr>
      <td colspan="3">Resposta</td>
    </tr>
    <tr>
      <td>Tipo</td>
      <td colspan="2">JSON</td>
    </tr>
    <tr>
      <td>Exemplo</td>
        <td>
          <br>&emsp;{
          <br>&emsp;&emsp;"id": 1001,
          <br>&emsp;&emsp;"email": "exemplo@email.com.br",
          <br>&emsp;&emsp;"token": "eyJ1bmlxdWVfbmFtZSI6IlRoaWFnbyIsInN1YAQSEFR"
          <br>&emsp;}
        </td>
    </tr>
    </table>
</html>

==== Recuperar Token ====

  * Recupera o token.

<html>
<table>
      <tr>
        <td>Path</td>
        <td colspan="2">{url_base}/api/v1/ic/tokens</td>
      </tr>
      <tr>
        <td>Tipo</td>
        <td colspan="2">GET</td>
      </tr>
      <tr>
        <td colspan="3">Cabeçário da Requisição</td>
      </tr>
      <tr>
        <td>Authorization</td>
        <td colspan="2">Bearer {token usuário}</td>
      </tr>  
    <tr>
      <td colspan="3">Resposta</td>
    </tr>
    <tr>
      <td>Tipo</td>
      <td colspan="2">JSON</td>
    </tr>
    <tr>
      <td>Exemplo</td>
        <td>
          <br>&emsp;{
          <br>&emsp;&emsp;"id": 1001,
          <br>&emsp;&emsp;"token": "eyJ1bmlxdWVfbmFtZSI6IlRoaWFnbyIsInN1YAQSEFR"
          <br>&emsp;}
        </td>
    </tr>
    </table>
</html>

==== Promoção ====

  * Registra a promoção.

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

==== Promoção / Clientes ====

  * Recupera os clientes da promoção.

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

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

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

===== MVS =====

==== Gerar Token ====

  * Registra um token.

<html>
<table>
      <tr>
        <td>Path</td>
        <td colspan="2">{url_base}/api/v1/mvs/tokens</td>
      </tr>
      <tr>
        <td>Tipo</td>
        <td colspan="2">POST</td>
      </tr>
      <tr>
        <td colspan="3">Cabeçário da Requisição</td>
      </tr>
      <tr>
        <td>Authorization</td>
        <td colspan="2">Bearer {token usuário}</td>
      </tr>  
    <tr>
      <td colspan="3">Resposta</td>
    </tr>
    <tr>
      <td>Tipo</td>
      <td colspan="2">JSON</td>
    </tr>
    <tr>
      <td>Exemplo</td>
        <td>
          <br>&emsp;{
          <br>&emsp;&emsp;"id": 1001,
          <br>&emsp;&emsp;"email": "exemplo@email.com.br",
          <br>&emsp;&emsp;"token": "eyJ1bmlxdWVfbmFtZSI6IlRoaWFnbyIsInN1YAQSEiT"
          <br>&emsp;}
        </td>
    </tr>
    </table>
</html>

==== Recuperar Token ====

  * Recupera o token.

<html>
<table>
      <tr>
        <td>Path</td>
        <td colspan="2">{url_base}/api/v1/mvs/tokens</td>
      </tr>
      <tr>
        <td>Tipo</td>
        <td colspan="2">GET</td>
      </tr>
      <tr>
        <td colspan="3">Cabeçário da Requisição</td>
      </tr>
      <tr>
        <td>Authorization</td>
        <td colspan="2">Bearer {token usuário}</td>
      </tr>  
    <tr>
      <td colspan="3">Resposta</td>
    </tr>
    <tr>
      <td>Tipo</td>
      <td colspan="2">JSON</td>
    </tr>
    <tr>
      <td>Exemplo</td>
        <td>
          <br>&emsp;{
          <br>&emsp;&emsp;"id": 1001,
          <br>&emsp;&emsp;"token": "eyJ1bmlxdWVfbmFtZSI6IlRoaWFnbyIsInN1YAQSEiT"
          <br>&emsp;}
        </td>
    </tr>
    </table>
</html>

==== Promoção / Clientes ====

  * Registra a promoção.

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

==== Configuração ====

  * Registra a configuração mvs.

<html>
<table>
      <tr>
        <td>Path</td>
        <td colspan="2">{url_base}/api/v1/mvs/configs</td>
      </tr>
      <tr>
        <td>Tipo</td>
        <td colspan="2">POST</td>
      </tr>
      <tr>
        <td colspan="3">Cabeçário da Requisição</td>
      </tr>
      <tr>
        <td>Authorization</td>
        <td colspan="2">Bearer {token usuário}</td>
      </tr>
      <tr>
        <td colspan="3">Corpo de Requisição</td>
      </tr>
      <tr colspan="2">
        <td>Tipo</td>
        <td colspan="2">JSON(application/json)</td>
      </tr>
      <tr colspan="2">
        <td>access_token</td>
        <td colspan="2">Text, Obrigatório</td>
      </tr>
      <tr colspan="2">
        <td>url_promotion</td>
        <td colspan="2">String(200), Obrigatório</td>
      </tr>
      <tr colspan="2">
        <td>Exemplo</td>
        <td colspan="2">
          <br>&emsp;{
          <br>&emsp;&emsp;"access_token": "eyJ1bmlxdWVfbmFtZSI6IlRoaWFnbyIsInN1YAQSEiT"
          <br>&emsp;&emsp;"url_promotion": "https://mvs.com.br/promotions",
          <br>&emsp;}
        </td>
      </tr>
    <tr>
      <td colspan="3">Resposta</td>
    </tr>
    <tr>
      <td>Tipo</td>
      <td colspan="2">JSON</td>
    </tr>
    <tr>
      <td>Exemplo</td>
        <td colspan="2">
          <br>&emsp;{
          <br>&emsp;&emsp;"id": 4001
          <br>&emsp;}
        </td>
    </tr>
    </table>
</html>

===== Loja =====

==== Recuperar Lojas ====

  * Recupera as lojas.

<html>
<table>
      <tr>
        <td>Path</td>
        <td colspan="2">{url_base}/api/v1/stores</td>
      </tr>
      <tr>
        <td>Tipo</td>
        <td colspan="2">GET</td>
      </tr>
      <tr>
        <td colspan="3">Cabeçário da Requisição</td>
      </tr>
      <tr>
        <td>Authorization</td>
        <td colspan="2">Bearer {token usuário}</td>
      </tr>  
    <tr>
      <td colspan="3">Resposta</td>
    </tr>
    <tr>
      <td>Tipo</td>
      <td colspan="2">JSON</td>
    </tr>
    <tr>
      <td>Exemplo</td>
        <td>
          <br>&emsp;[
          <br>&emsp;&emsp;{
          <br>&emsp;&emsp;&emsp;"id": 1001,
          <br>&emsp;&emsp;&emsp;"user_id": 1031,
          <br>&emsp;&emsp;&emsp;"document": "99999999999999",
          <br>&emsp;&emsp;&emsp;"active": 1,
          <br>&emsp;&emsp;&emsp;"created_at": "2019-07-19 13:52:34"
          <br>&emsp;&emsp;&emsp;"updated_at": "2019-07-19 13:52:34"
          <br>&emsp;&emsp;}
          <br>&emsp;]
        </td>
    </tr>
    </table>
</html>

==== Recuperar Loja ====

  * Recupera a loja informada.

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

==== Salvar loja ====

  * Registra ou atualiza a loja do usuário.

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

==== Excluir loja ====

  * Exclui um loja do usuário.

<html>
<table>
      <tr>
        <td>Path</td>
        <td colspan="2">{url_base}/api/v1/stores/{id}</td>
      </tr>
      <tr>
        <td>Tipo</td>
        <td colspan="2">DELETE</td>
      </tr>
      <tr>
        <td colspan="3">Cabeçário da Requisição</td>
      </tr>
      <tr>
        <td>Authorization</td>
        <td colspan="2">Bearer {token usuário}</td>
      </tr>
      <tr>
        <td colspan="3">Parâmetros do Path</td>
      </tr>
      <tr>
        <td>Nome</td>
        <td>Tipo</td>
        <td>Descrição</td>
      </tr>
      <tr>
        <td>{id}</td>
        <td>Inteiro(20)</td>
        <td>Id da loja</td>
      </tr>
    </table>
</html>

==== Promoções ====

==== Recuperar promoções ====

  * Recupera as promoções.

<html>
<table>
      <tr>
        <td>Path</td>
        <td colspan="2">{url_base}/api/v1/promotions</td>
      </tr>
      <tr>
        <td>Tipo</td>
        <td colspan="2">GET</td>
      </tr>
      <tr>
        <td colspan="3">Cabeçário da Requisição</td>
      </tr>
      <tr>
        <td>Authorization</td>
        <td colspan="2">Bearer {token usuário}</td>
      </tr>  
    <tr>
      <td colspan="3">Resposta</td>
    </tr>
    <tr>
      <td>Tipo</td>
      <td colspan="2">JSON</td>
    </tr>
    <tr>
      <td>Exemplo</td>
        <td>
          <br>&emsp;[
          <br>&emsp;&emsp;{
          <br>&emsp;&emsp;&emsp;"id": 1001,
          <br>&emsp;&emsp;&emsp;"store_id": 1031,
          <br>&emsp;&emsp;&emsp;"start_date": "2019-07-19",
          <br>&emsp;&emsp;&emsp;"finish_date": "2019-07-19",
          <br>&emsp;&emsp;&emsp;"barcode": "7892123456789",
          <br>&emsp;&emsp;&emsp;"value": 21,
          <br>&emsp;&emsp;&emsp;"type": "abs",
          <br>&emsp;&emsp;&emsp;"qty_ticket": 12,
          <br>&emsp;&emsp;&emsp;"qty_sales": 12
          <br>&emsp;&emsp;}
          <br>&emsp;]
        </td>
    </tr>
    </table>
</html>

==== Recuperar clientes da promoção ====

  * Recupera os clientes da promoção.

<html>
<table>
      <tr>
        <td>Path</td>
        <td colspan="2">{url_base}/api/v1/promotions/{id}/customers</td>
      </tr>
      <tr>
        <td>Tipo</td>
        <td colspan="2">GET</td>
      </tr>
      <tr>
        <td colspan="3">Cabeçário da Requisição</td>
      </tr>
      <tr>
        <td>Authorization</td>
        <td colspan="2">Bearer {token usuário}</td>
      </tr>  
    <tr>
        <td colspan="3">Parâmetros do Path</td>
      </tr>
      <tr>
        <td>Nome</td>
        <td>Tipo</td>
        <td>Descrição</td>
      </tr>
      <tr>
        <td>{id}</td>
        <td>Inteiro(20)</td>
        <td>Id da loja</td>
      </tr>
    <tr>
      <td colspan="3">Resposta</td>
    </tr>
    <tr>
      <td>Tipo</td>
      <td colspan="2">JSON</td>
    </tr>
    <tr>
      <td>Exemplo</td>
        <td>
          <br>&emsp;[
          <br>&emsp;&emsp;{
          <br>&emsp;&emsp;&emsp;"id": 1001,
          <br>&emsp;&emsp;&emsp;"name": "João Almeida Neves",
          <br>&emsp;&emsp;&emsp;"document": "99999999999",
          <br>&emsp;&emsp;&emsp;"phone_number": "99999999999",
          <br>&emsp;&emsp;&emsp;"active": 1,
          <br>&emsp;&emsp;&emsp;"address": "Rua Cel. Joaquim Francisco",
          <br>&emsp;&emsp;&emsp;"district": "Varginha",
          <br>&emsp;&emsp;&emsp;"number": 409,
          <br>&emsp;&emsp;&emsp;"city": "Itajubá",
          <br>&emsp;&emsp;&emsp;"state": "MG",
          <br>&emsp;&emsp;&emsp;"activation_date": "2019-02-28",
          <br>&emsp;&emsp;}
          <br>&emsp;]
        </td>
    </tr>
    </table>
</html>
Documentação de software

Ferramentas do usuário

Ferramentas do site

Ferramentas da página
