O que é o Dashboard da API?
O Dashboard da API Externa da Noodle é uma ferramenta auxiliar que permite acompanhar e visualizar sua integração com nossa API de forma prática. Desenvolvido para facilitar o desenvolvimento e testes durante o processo de integração, o dashboard oferece uma interface visual para explorar as funcionalidades da API.🎯 Para quem é o Dashboard?
O dashboard é uma ferramenta de apoio para desenvolvedores e equipes técnicas que estão integrando com a API Externa da Noodle e desejam visualizar e testar as funcionalidades de forma interativa.
🚀 O que você pode fazer
O dashboard permite visualizar e testar as principais funcionalidades da API durante sua integração:📦 Como Usar
Acesse o Código Fonte
O código fonte completo está disponível no GitHub com instruções detalhadas de configuração e uso.
- Acesse o código fonte no GitHub para configurar localmente
- Configure suas credenciais da API Externa da Noodle
- Execute o dashboard em seu ambiente de desenvolvimento
- Explore as funcionalidades para entender como a API funciona
- Teste suas integrações de forma visual antes de implementar
Importante: O dashboard é uma ferramenta de desenvolvimento e testes. Para uso em produção, implemente as chamadas da API diretamente em sua aplicação seguindo nossa documentação técnica.
🌐 Ambientes Suportados
O dashboard suporta alternância entre diferentes ambientes:- Homologação:
https://homolog.api.noodle.cx/external - Produção:
https://production.api.noodle.cx/external
🔐 Autenticação
O dashboard utiliza o mesmo sistema de autenticação da API, permitindo que você teste e entenda como funciona o processo de autenticação antes de implementar em sua aplicação.Entenda a Autenticação
Aprenda em detalhes como funciona nosso fluxo de assinatura e como implementá-lo em sua integração.
📚 Explorando as Funcionalidades
Testando Splits
- Visualize como funciona a criação de splits
- Entenda a estrutura de dados necessária
- Veja como os QR Codes PIX são gerados automaticamente
- Acompanhe o fluxo de status dos pagamentos
Explorando Contatos
- Teste o cadastro de contatos e contas bancárias
- Entenda quais dados são necessários
- Veja como validar as informações antes de usar na API
Experimentando Validações
- Nota Fiscal: Teste o upload e validação de PDFs para entender o formato esperado
- Conta Bancária: Veja como funciona a validação através de transferência PIX de teste
🎯 Benefícios Durante a Integração
Aprendizado Visual: Entenda como a API funciona através de uma interface prática antes de implementar em sua aplicação.
- Exploração: Descubra todas as funcionalidades disponíveis na API
- Testes: Experimente diferentes cenários e veja os resultados em tempo real
- Compreensão: Visualize a estrutura de dados e fluxos da API
- Validação: Confirme se sua integração está funcionando corretamente
📞 Suporte
Para dúvidas sobre o dashboard ou problemas técnicos:Contato de Suporte
Entre em contato com nossa equipe técnica para suporte especializado.
Desenvolvido com ❤️ pela equipe Noodle