Exemplo de Cenário de Integração
Consulta/Autentica Clientes
Objetivo:
Indicar uma chave única (no caso é o CNPJ) para que o sistema retorne o cadastro desse cliente com todos os dados necessários para verificação de autenticidade e classificação de tipo e status do cliente.
Endpoint: https://xvnl0w6sa8.execute-api.sa-east-1.amazonaws.com/default/evolux_comercial
Método: GET
Parâmetros:
doc: (string)
Ex: "14190549000109"
Body (Form-Data):
servico: consulta_cliente
Exemplo de chamada:
curl --location --request GET 'https://xvnl0w6sa8.execute-api.sa-east-1.amazonaws.com/default/evolux_comercial?doc=14190549000109' \
--header 'x-api-key: [SUPRIMIDO POR SEGURANÇA]' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'servico=consulta_cliente'
Retornos:
404 - Not Found
{
"error": "Cliente não encontrado"
}
200 - OK
{
"id": "900001",
"razaoSocial": "EVOLUX SISTEMAS LTDA",
"nome": "Evolux",
"CNPJ": "14190549000109",
"CNPJ_formatado": "14.190.549/0001-09",
"email": "hamiltonreisparreiras@gmail.com",
"telefone": "1154000000",
"Logradouro": "Rua Doutor Poty Nobrega, 1946",
"Bairro": "Lagoa Nova",
"Cidade": "Natal",
"uf": "RN",
"cep": "59.056-180",
"representante": {
"nome": "Cláudio Borro",
"telefone": "19992939965",
"email": "claudio.borro@carrier.com"
},
"status": "Ativo",
"pedidos": {
"quantidade": 2,
"pedidos": [
{
"numeroPedido": "8798",
"dataPedido": "2021-05-31T13:50Z",
"statusPedido": "já foi entregue e está finalizado",
"statusEntrega": "já foi entregue",
"tipoProduto": "Extintor",
"modeloProduto": "42AGVCB09M5",
"valorProduto": "1.766,07",
"codBarras": "0 2 1 3 9 4 4 0 1 7 6 6 0 7 9 8 8 0 0 0 1 6 4 3 2 1 0 0 5 7 2 3 7 0 9 ",
"urlBoleto": "https://www.fazenda.mg.gov.br/empresas/legislacao_tributaria/files/nota_fiscal_mod_1.pdf"
},
{
"numeroPedido": "8808",
"dataPedido": "2020-07-21T13:50Z",
"statusPedido": "foi cancelado",
"statusEntrega": "não chegou a ser despachado. Verifique o status do pedido.",
"tipoProduto": "Ar Condicionado",
"modeloProduto": "42AGVQC12M5",
"valorProduto": "3.106,00",
"codBarras": "0 2 1 3 9 4 4 0 3 1 0 6 0 0 9 8 8 0 0 0 1 6 4 3 2 1 0 0 5 7 2 3 7 0 9 ",
"urlBoleto": "https://www.fazenda.mg.gov.br/empresas/legislacao_tributaria/files/nota_fiscal_mod_1.pdf"
}
]
}
}
Consulta Pedido:
Objetivo:
Indicar o número de um pedido e obter as informações financeiras e de logística deste objeto
Endpoint: https://xvnl0w6sa8.execute-api.sa-east-1.amazonaws.com/default/evolux_comercial
Método: GET
Parâmetros:
pedido: (int)
Ex: 3613
Body (Form-Data):
servico: consulta_pedido
Exemplo de chamada:
Retornos:
404 - Not Found
200 - OK