Developer API
Integre seu sistemaà AGGU com segurança.
Seu sistema pede, a AGGU responde só o que foi liberado. Cada chamada fica no histórico.
- Clientes da carteira38 clientesSó os liberados
- Documentos de setembro12 documentosCom a competência
- Guia publicadaAviso enviadoAo seu sistema
Exemplos ilustrativos.
- Uma chave por integração
- Acesso só ao liberado
- Avisos automáticos
- Histórico de cada chamada
Quatro passos em cada chamada.
Seu sistema se identifica com a chave dele. A AGGU confere a permissão, responde e registra.
- IdentificaA chave da integração
- ConfereLeitura de clientes
- RespondeSó o que foi liberado
- RegistraQuem, quando, resultado
O que o seu sistema pode pedir.
Consultar clientes, enviar documentos, abrir solicitações e receber avisos. O que não foi liberado é recusado.
Exemplos ilustrativos. Os formatos finais estão na documentação técnica.
Consultar clientesExemplo 1 de 3
- PedidoClientes ativos da carteiraConsulta
- PermissãoLeitura de clientesLiberada
- Resposta38 clientes com nome, CNPJ e regimeEnviada
Enviar documentoExemplo 2 de 3
- PedidoExtrato de setembro · Comercial LimaEnvio
- PermissãoEnvio de documentosLiberada
- RespostaDocumento recebido e ligado à empresaRecebido
Pedido fora da permissãoExemplo 3 de 3
- PedidoExcluir cadastro de clienteExclusão
- PermissãoNão liberada para esta chaveRecusada
- RespostaPedido recusado e registradoRegistrado
Repetir não duplica. Excesso não derruba.
Se o mesmo pedido chega duas vezes, o resultado é um só. Se o volume passa do limite, a AGGU avisa quanto esperar.
Pedido repetido
- Abrir solicitaçãoAlteração de endereço · Padaria Horizonte
- Abrir solicitaçãoO mesmo pedido, de novoMesmo resultado
0solicitação criada
Volume de pedidos
NormalAbaixo do limite
A chave fica guardada com você.
Uma chave por integração, com o mínimo de acesso. Quando alguém sai do projeto, troque a chave.
- Chave só no servidor, nunca no site ou no app
- Confira a assinatura de cada aviso
Chaves de integração
Guardadas no servidor do escritório
- Integração ERPLeitura de clientes · Envio de documentos
••••4F2Ausada hoje 10:14 - Painel de BILeitura de solicitações
••••91C7usada hoje 10:20
A referência completa vai para o seu time técnico.
Formatos, chaves, avisos e ambiente de testes, entregues conforme o ambiente liberado.
- Formatos e campos de cada pedido
- Como criar e trocar chaves
- Lista de avisos automáticos
- Ambiente de testes antes da produção
Entregue ao seu time técnicoconforme o ambiente liberado
Seu sistema conversando com a AGGU.
- Chave e permissões
- Avisos automáticos
- Histórico de cada chamada