DOCUMENTAÇÃO API EXTRATTA

Este documento é destinado a profissionais de TI (desenvolvedores de sistemas) e tem como objetivo detalhar os métodos para realizar a integração com a API da EXTRATTA para:

  • Emissão de CIOT (Padrão e/ou TAC Agregado)
  • PEF - Pagamento Eletrônico de Frete (Cartão Extratta)
  • VPO - Vale Pedágio Obrigatório (HUB de Vale Pedágio)
  • Diárias - Despesas de Viagem (Cartão Extratta)

Em relação aos fornecedores de vale-pedágio (VPO), trabalhamos com os seguintes fornecedores:

  • TAG Sem parar: CNPJ 04.088.208/0001-65 - CGMP - CENTRO DE GESTÃO DE MEIOS DE PAGAMENTO LTDA;
  • TAG Move Mais: CNPJ 15.266.912/0001-87 - MOVE MAIS MEIOS DE PAGAMENTO LTDA;
  • TAG VELOE: CNPJ 04.740.876/0001-25 - ALELO S/A (VELOE);
  • TAG Extratta by Move Mais: CNPJ 15.266.912/0001-87 - MOVE MAIS MEIOS DE PAGAMENTO LTDA;
  • TAG ConectCar: CNPJ 16.577.631/0002-99 - CONECTCAR INSTITUIÇÃO DE PAGAMENTO E SOLUÇÕES DE MOBILIDADE ELETRÔNICA S.A;
  • TAG Taggy Edenred: CNPJ 36.000.836/0001-33 - EXTRATTA MEIOS DE PAGAMENTO LTDA;
  • Moedeiro: Compra VPO em cartão foi descontinuada e não está mais disponível para novas transações.


REQUISITOS DE COMUNICAÇÃO

A comunicação entre o cliente e o servidor será feita na arquitetura REST e o formato de dados em JSON.

Para acesso aos métodos de integração, será necessário que tenha conexão com a internet.

Nosso protocolo atende as novas exigências da ANTT, comunicando informações através de JSON, onde todas as validações retornadas são oriundas das regras de negócio aplicadas pela ANTT em seus respectivos ambiente.


AUTENTICAÇÃO

Para todas as requisições realizadas no Web Service (API), é necessário que alguns dados sejam enviados para autenticação. Ambos são obrigatórios e a falta ou invalidez de qualquer um deles terá a requisição rejeitada. Os dados são:

  • CNPJAplicacao: CNPJ da aplicação será o CNPJ concedido a empresa para realizar qualquer requisição.
  • TOKEN: Complementando o CNPJ da aplicação, o token será uma chave concedida pela EXTRATTA. Este token é único para cada CNPJAplicação.
  • CNPJEmpresa: CNPJ da empresa será o CNPJ concedido a empresa para realizar qualquer requisição, deve ser utilizado o mesmo CNPJAplicacao.
Cabeçalho
Chave Descrição Elem. Tipo Ocor. Tamanho Versão
CNPJAplicacao CNPJ da Aplicação Para autenticação E Caractere 1-1 14 1.0
Token Gerado a partir do CNPJ de autenticação para validar permissões de acesso E Caractere 1-1 100 1.0
CNPJEmpresa CNPJ da Empresa para Autenticação ( mesmo CNPJAplicação ) E Caractere 1-1 100 1.0


COMUNICAÇÃO - API

API de Homologação:


Para realizar integrações em base de HOMOLOGAÇÃO, são disponibilizados os link’s abaixo:


  • API para integrações entre sistemas: http://apiho.extratta.com.br:50063/
  • Acesso ao Portal Web/Site: http://homolog.extratta.com.br:8024/
  • Impressão do CIOT: http://apiho.extratta.com.br:1000/Ciot/ServicesFull/Reports/DeclaracaoTransporte/{0}/{1}
  • Impressão do Recibo Vale-Pedágio: http://apiho.extratta.com.br:50063/ViagemAts/ReciboVPO/IdViagem
  • Impressão do Recibo Pagamento de Frete: http://apiho.extratta.com.br:50063/ViagemAts/ReciboPEF?json={IdViagem:idViagem,ListarParcelasCanceladas:false}


API de Produção:


Após o processo validado/homologado deve ser solicitado as credenciais para operação em PRODUÇÃO:

  • URL / API: https://api.extratta.com.br:2002/
  • Acesso a Plataforma: http://portal.extratta.com.br/login
  • Impressão CIOT: https://ciot.extratta.com.br/ciot/ServicesFull/Reports/DeclaracaoTransporte/{0}/{1}
  • Impressão do Recibo Vale-Pedágio: https://api.extratta.com.br:2110/ViagemAts/ReciboVPO/IdViagem
  • Impressão do Recibo Pagamento de Frete: https://api.extratta.com.br:2110/ViagemAts/ReciboPEF?json=%7BIdViagem: idViagem,ListarParcelasCanceladas:false%7D

{0} Número do CIOT

{1} Senha do CIOT


SIGLAS E ABREVIATURAS


ELEMENTOS

SIGLA DESCRIÇÃO
E Elemento: Tag referente a um campo único dentro do Json
G Grupo: Tag referente a objeto único dentro do Json, envolvendo diversos elementos dentro de si.
A Array: Tag referente a uma lista de objetos dentro do Json


OCORRÊNCIA

OCORRÊNCIA DESCRIÇÃO
1-1 Indicação de que a TAG é obrigatória no envio ou retorno
1-0 Indicação de que a TAG é opcional no envio
0-1 Indicação de que a TAG é opcional no retorno


CONTATO/SUPORTE

Canais de comunicação:

Telefone / WhatsApp : (49) 9826-7358

E-mail : suporte@extratta.com.br