TX Fuel Developers
Wiki
APIs de terceiro

ZP

APIs para integrar sistemas de terceiros (ERP, software house…) ao ZP: cobrança, cartão e documentos fiscais. O manual completo fica na wiki; esta página é o atalho para cada parte.

Comece aqui

Os quatro passos de toda integração.

Peça o acessoAo suporte: você recebe o servidor, o perfil, o identificador (segredo) e o id do app (A).
Monte a senha do diaTodo pedido leva o perfil, a SENHA do dia e A. Código pronto em várias linguagens na wiki.
Veja o que o seu perfil pode fazerApp, rede, filial, cliente: cada perfil lê e grava um escopo diferente.
Teste no SwaggerNo navegador, com a senha do dia calculada na própria página. Códigos de retorno: respostas e erros.

Ferramentas

Tudo gerado da mesma fonte que o manual: o que está aqui é o que está na wiki. Como usar cada uma ↗

Servidores

Use o servidor informado pela TX Fuel: os dados de cada empresa ficam em um deles.

ServidorEndereço base
Servidor 1https://zp1.txfuel.com.br/api
Servidor 2https://zp2.txfuel.com.br/api
# teste de conexão e credencial (responde {"status":"ok"})
curl "https://zp1.txfuel.com.br/api/v1/terceiro/status?APP=NOME&SENHA=SENHA_DO_DIA&A=ID_DO_APP"

Assuntos

Endpoints por assunto. Parâmetros, corpo, respostas e exemplos ficam na página de cada assunto na wiki.

Cobranças

Ver na wiki ↗

Emissão, consulta e cancelamento de cobranças por boleto, PIX e cartão de crédito (uma ou várias por chamada, em lote), acompanhamento dos lotes e cofre de cartões usados nas cobranças por cartão.

GETPOSTDELETEcobrancaGETloteGETPOSTPUTDELETEcartao

Cedentes e software houses

Ver na wiki ↗

Para software houses que revendem o ZP Cobrança aos seus clientes: cadastro da software house e cadastro/alteração dos cedentes (com conta bancária e convênio) da sua rede.

GETPOSTPUTcedentePOSTsoftwareHouse

Documentos fiscais

Ver na wiki ↗

Consulta das NF-e e CT-e emitidas e recebidas pelo CNPJ da filial (chaves, situação e manifesto), resumo por situação/modal e andamento da captura das NF-e recebidas.

GETnfeChaveGETnfeResumoGETnfeRecebidaStatusGETcteChave

Utilitários

Ver na wiki ↗

Teste da credencial, consulta de CEP e de localidade, validação cadastral de CPF/CNPJ e observações livres ligadas a registros.

GETstatusGETconsultarCepGETlocalizarLocalidadeGETvalidarPessoaFisicaGETvalidarPessoaJuridicaGETPOSTPUTDELETEtxObservacao

Suporte

Acesso, identificador, dúvidas e erros 500.