Skip to content

Noodle-Cx/api-dashboard

Repository files navigation

API Dashboard - Noodle

📋 Sobre o Projeto

O API Dashboard é uma ferramenta desenvolvida para auxiliar clientes da Noodle que estão integrando via API e devem seguir nossa documentação oficial em developer.noodle.cx.

🎯 Propósito

Este dashboard foi criado especificamente para:

  • Clientes Noodle com conta ativa que desejam integrar via API
  • Testes e desenvolvimento de integrações com a API Externa da Noodle
  • Demonstração das funcionalidades disponíveis na API

⚠️ Importante - Uso Interno

Este dashboard é destinado exclusivamente para uso interno e testes. NÃO deve ser publicado aberto na internet.

Se nosso cliente desejar publicar seu próprio dashboard, ele precisa implementar autenticação e controle de acesso próprios para garantir a segurança dos dados.

🚀 Funcionalidades Principais

  • Gerenciamento de Splits: Criar e gerenciar lotes de pagamento
  • Validação de Documentos: Upload e validação de Notas Fiscais (PDF)
  • Validação de Contas: Verificação de contas bancárias e chaves PIX
  • QR Codes PIX: Geração de códigos PIX dinâmicos e estáticos
  • Webhooks: Configuração de notificações em tempo real
  • Gestão de Contatos: Cadastro e gerenciamento de beneficiários
  • Relatórios: Comprovantes e extratos de pagamentos

🔑 Como Obter Acesso

Para utilizar este dashboard e a API da Noodle, você precisa:

  1. Ter uma conta Noodle ativa (Pessoa Jurídica)
  2. Solicitar credenciais de API através do email: api@noodle.cx
  3. Seguir a documentação completa em: developer.noodle.cx

📧 Contato para Credenciais

Email: api@noodle.cx

Inclua em sua solicitação:

  • Nome da empresa
  • CNPJ
  • Descrição do projeto de integração
  • Ambiente desejado (homologação/produção)

🌐 Ambientes Disponíveis

  • Homologação: https://homolog.api.noodle.cx/external
  • Produção: https://production.api.noodle.cx/external

🔐 Autenticação

A API utiliza autenticação JWT com assinatura ES256 e chaves assimétricas para máxima segurança. Cada requisição é protegida por uma assinatura única gerada com sua chave privada.

Para detalhes completos sobre autenticação, consulte: developer.noodle.cx/authentication

📚 Documentação Completa

Para informações detalhadas sobre:

  • Endpoints da API
  • Exemplos de código
  • Webhooks e eventos
  • Guias de integração

Acesse nossa documentação oficial: developer.noodle.cx

🛠️ Configuração Técnica

Para desenvolvedores que precisam configurar e executar este dashboard localmente, consulte o arquivo README-TECHNICAL.md que contém:

  • Instruções de instalação
  • Configuração de ambiente
  • Estrutura do projeto
  • Guias de desenvolvimento
  • Solução de problemas

📞 Suporte


Desenvolvido com ❤️ pela equipe Noodle

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages