...
Painel | ||||||
---|---|---|---|---|---|---|
| ||||||
|
1 Conceito
A API de Recolha Genérica permite que seja integrado com demais cartões frotas, para isso é necessário que sejam configuradas as URLS necessárias para integração.
2 Requisitos
Para utilização desta integração será necessário alguns requisitos:
- A versão exigida é a 3.3.1.127 (AutoSystem) ou superior;
- Ter o módulo Recolha de Notas liberado na Intranet;
- Ter um ambiente que atenda a documentação abaixo.
3 Configurações Gerais
Abaixo serão descritas as principais configurações para que a integração funcione com sucesso.
3.1 Configuração Integração
No módulo Gerencial, acessar o menu Configurações > Módulos > Configurações de Frota > Recolha de Notas, selecionar a empresa desejada e clicar no ícone “+” para cadastrar a recolha, é possível cadastrar várias recolhas para uma empresa.
...
Será exibido um “X” na recolha selecionada, informando que a mesma está desativada:
4 Fluxo de Integração
O fluxo de integração com a API é configurado da seguinte forma:
- Durante o processo da venda, o sistema consulta a API enviando o código do estabelecimento e o número de autorização (TEF ou POS), para obter o retorno dos dados de emissão da NF-e;
- Após o processo de emissão da NF-e o sistema envia o arquivo de XML da nota fiscal caso o cliente utilize o sistema de recolha de notas.
5 Autenticação API
A autenticação para utilização da API deve ser executada através do esquema "HTTP Basic". Neste processo de autenticação, é utilizado um login e senha. Geralmente, as bibliotecas cuidam do envio do usuário e senha, ou seja, basta informar um nome de usuário e uma senha válidos e a biblioteca fará todo o resto. Caso contrário, será possível implementar a autenticação manualmente. Para isso, basta enviar em cada requisição um cabeçalho HTTP com o nome "Authorization".
...
Portanto, para um par de login/senha onde o login seja "teste" e a senha também seja "teste", temos o cabeçalho final: Basic dGVzdGU6dGVzdGU=
6 API's de Integração: Consulta NF-e
Para a emissão da Nota Fiscal Eletrônica (NF-e) com base no código de autorização da transação do cartão, é necessário consultar as informações relevantes.
...
Bloco de código | ||||
---|---|---|---|---|
| ||||
Retorno Status 200: { "cnpj": "12345678901234", "razaoSocial": "Company Name", "inscricaoEstadual": "1234567890", "cfop": "123456", "quilometragem": "10000", "placaDoVeiculo": "ABC1234", "endereco": { "logradouro": "Street Name", "numero": "123", "complemento": "Apt 4", "bairro": "Neighborhood", "cidade": "City", "uf": "CA", "cep": "12345678", "codigoIbge": 1234567 } Retorno Status 460 (Erros referentes as regras operacionais do sistema de recolha): { "erros": [ { "codigo":"001", "detalhe":"Cliente não possui recolha de notas" } ] } |
7 API's de Integração: Upload de Nota Fiscal
Possibilita que o estabelecimento envie o arquivo XML de nota fiscal emitida para o cliente que utiliza o sistema de recolha de notas.
...
Bloco de código | ||||
---|---|---|---|---|
| ||||
Request - [Content-Type: application/json] { "codigoEstabelecimento": 123456, "codigoAutorizacao": 789012, "dataAutorizacao": "2022-01-01", "arquivo": { "nomeOriginal": "nota_fiscal.xml", "base64Encode": "SGVsbG8gd29ybGQh", "MD5hash": "5eb63bbbe01eeed093cb22bb8f5acdc3" } } |
8 Vídeo Explicativo
Confira abaixo um vídeo explicativo com as informações descritas acima:
...