Como configurar integrações e a API pública

Integrações está disponível para Administrador e depende do plano contratado.

No plano Starter, tentar abrir Integrações redireciona para o Dashboard, sem mensagem explicativa. O recurso fica disponível a partir do Premium.

Criar uma chave de API

1. Abra Integrações e clique em Nova chave.
2. Informe Nome, a Validade opcional e o Escopo.
3. Clique em Criar chave.
4. Copie a Chave completa imediatamente. Depois de fechar a janela, ela não será exibida novamente.

O escopo LEITURA permite consultas; EMISSAO permite operações de emissão e criação previstas na API. Na lista, use as ações disponíveis para rotacionar ou revogar uma chave. Envie a chave no cabeçalho HTTP indicado em Uso da API pública e consulte os contratos em docs/API-PUBLICA.md.

Conectar o MCP remoto

O MCP remoto permite consultar dados e solicitar operações do NotasPJ por uma conversa em clientes compatíveis, sem montar manualmente cada chamada da API. O recurso está disponível nos planos Premium, Business e Scale.

Para conectar:

1. Em Integrações, crie uma chave com escopo LEITURA para consultas ou EMISSAO quando o cliente também precisar emitir.
2. No cliente MCP, adicione um servidor HTTP com o endereço https://www.notaspj.com.br/api/mcp.
3. No campo de autenticação do cliente, informe a chave criada.
4. Teste primeiro uma consulta, como listar as empresas ou verificar o uso do mês.

O MCP pode listar empresas e clientes, consultar NFS-e, obter os dados e o link da DANFSe, consultar a franquia do mês e emitir uma NFS-e quando a chave permite emissão.

Perfis tributários na API e no MCP

Cadastre os perfis na tela Perfis tributários. A API e o MCP podem listar ou sugerir esses cadastros para que a integração escolha um deles e informe seu perfilTributarioId ao enviar a nota; nenhum perfil é aplicado automaticamente.

Atenção: a ferramenta de emissão pelo MCP gera uma nota fiscal real, com os mesmos efeitos de uma emissão pela tela. Antes de confirmar, confira a empresa emissora, o tomador, o valor e a descrição do serviço. A definição dos campos e das decisões tributárias deve ser confirmada com o contador.

Criar um webhook

1. Na seção Webhooks, clique em Novo webhook.
2. Informe Descrição, uma URL HTTPS e selecione os Eventos.
3. Clique em Criar webhook e copie o segredo exibido.

A lista permite testar, consultar entregas, reentregar e excluir conforme o estado do webhook. Guarde chaves e segredos em um cofre de credenciais; nunca os inclua em código-fonte ou mensagens.