> ## Documentation Index
> Fetch the complete documentation index at: https://developer.noodle.cx/llms.txt
> Use this file to discover all available pages before exploring further.

# Dashboard da API

> Ferramenta auxiliar para acompanhar sua integração com a API Externa da Noodle

## 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.

<Card title="🎯 Para quem é o Dashboard?" icon="users">
  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.
</Card>

## 🚀 O que você pode fazer

O dashboard permite visualizar e testar as principais funcionalidades da API durante sua integração:

<Cards columns={2}>
  <Card title="💰 Visualizar Splits" icon="split">
    Acompanhar splits criados, visualizar detalhes dos pagamentos e testar a criação de novos lotes.
  </Card>

  <Card title="👥 Explorar Contatos" icon="users">
    Visualizar contatos cadastrados e testar o cadastro de novos contatos com contas bancárias.
  </Card>

  <Card title="✅ Testar Validações" icon="check-circle">
    Experimentar a validação de notas fiscais (PDF) e teste de validação de contas bancárias.
  </Card>

  <Card title="📱 Gerar QR Codes PIX" icon="qr-code">
    Testar a geração de QR codes PIX dinâmicos e estáticos para entender como funcionam.
  </Card>

  <Card title="🏦 Consultar Instituições" icon="building">
    Explorar a base de bancos e instituições financeiras disponíveis na API.
  </Card>

  <Card title="🔔 Configurar Webhooks" icon="webhook">
    Testar configurações de webhook para entender como receber notificações de eventos.
  </Card>
</Cards>

## 📦 Como Usar

<Card title="Acesse o Código Fonte" icon="github" href="https://github.com/Noodle-Cx/api-dashboard">
  O código fonte completo está disponível no GitHub com instruções detalhadas de configuração e uso.
</Card>

Para usar o dashboard como ferramenta auxiliar durante sua integração:

1. **Acesse o código fonte** no GitHub para configurar localmente
2. **Configure suas credenciais** da API Externa da Noodle
3. **Execute o dashboard** em seu ambiente de desenvolvimento
4. **Explore as funcionalidades** para entender como a API funciona
5. **Teste suas integrações** de forma visual antes de implementar

<Note>
  **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.
</Note>

## 🌐 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`

Você pode alternar entre os ambientes usando o seletor no cabeçalho da aplicação.

## 🔐 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.

<Card title="Entenda a Autenticação" icon="key" href="/authentication">
  Aprenda em detalhes como funciona nosso fluxo de assinatura e como implementá-lo em sua integração.
</Card>

## 📚 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

<Info>
  **Aprendizado Visual:** Entenda como a API funciona através de uma interface prática antes de implementar em sua aplicação.
</Info>

* **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:

<Card title="Contato de Suporte" icon="mail" href="mailto:api@noodle.cx">
  Entre em contato com nossa equipe técnica para suporte especializado.
</Card>

***

**Desenvolvido com ❤️ pela equipe Noodle**


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.