O que é API?

O que é API?

O conceito de API nada mais é do que uma forma de comunicação entre sistemas. Ou seja, elas permitem a integração entre dois sistemas, em que um deles fornece informações e serviços que podem ser utilizados pelo outro, sem a necessidade de algum dos sistemas conhecer detalhes de implementação do software.

Documento da nossa API nas páginas 8 e 9 mostra os tipos de busca.

Nossa API Também é disponibilizada para fazer consulta.

Instruções

Contratação da API Comercial

A contratação poderá ser feita através do nosso setor comercial, onde serão liberados o acesso conforme dados abaixo:

Informações com o Comercial:

GUID: xxxxxxxxxxxxxxxxxxxxxxxxx ( Fornecido pela Gw Sistemas )
LOGIN: CNPJ do cliente
SENHA: CNPJ do cliente

Configurando no Gw Sistemas

No sistema cadastrar um Grupo de clientes.
Adicionar o Grupo de cliente no cadastro do cliente chave e nos demais clientes que a transportadora deseja visualizar as informações da carga.
1. O motivo de vincular um grupo de cliente é permitir que a consulta pela API seja disponibilizada apenas para os clientes que estiverem no mesmo grupo de cliente. Ex: cliente A e tenho o cliente B, se ambos tiverem o mesmo grupo de cliente e a opção "Ao consultar entregas deverá mostrar todas as entregas do mesmo grupo de clientes".
2. "Ao consultar entregas deverá mostrar todas as entregas do mesmo grupo de clientes", então pela API irá mostrar dados de ambos os clientes.
Preencham também os campos das capturas de tela com as marcações.

Essas informações serão enviadas para o cliente que fez a contratação da nossa API e vão fazer as devidas configurações e seu painel para visualizar as informações desejadas.

Como fazer a consulta na API ?

A transportadora fez a emissão do CT-e com as seguintes informações;

Nº CT-e 025599

Chave CT-e: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Nº NF-e 18154

Chave NF-e: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Como fazer a consulta da API no Postman

Collections: É onde está a pasta da integração;

1º Passo: Clicar em Get SolicitarToken.

2º Passo: Na aba Headers adicione as informações passa pelo comercial.

3º Passo: Depois clique em Send. Aguarde o postman está se conectando a API da Gw.

Após enviado a requisição

O Postman vai trazer a seguinte mensagem abaixo.

Após conectado

1º Passo: Clicar em listarCargas;

2º Passo: Clica na aba Body abaixo você vai digitar o que deseja buscar. Ex print.

3º Passo: Escolha a opção JSON para fazer a busca nesse formato.

4º Passo: Clicar em SEND e aguardar o Postman fazer a busca. Após fazer a busca abaixo mostrará os dados da carga.

Obs: A descrição da busca como exemplo é por data de emissão e é descrito da forma mostrada no print.

Base de conhecimento