Referência da API
Documentação completa de todos os endpoints, parâmetros, tipos de resposta e exemplos de requisição.
Acessar documentaçãoAPI & Sandbox
Integre sua plataforma ao SGP.
Acesse o ambiente sandbox para testar integrações, explorar endpoints e validar webhooks antes de ir para produção — sem afetar operações reais.
Recursos
Tudo que você precisa para integrar.
Playground interativo
Faça chamadas à API diretamente no navegador com autenticação sandbox pré-configurada.
Abrir playgroundEndpoints principais
Principais recursos disponíveis na API.
GET
/assinantes Lista assinantes com filtros e paginação POST
/assinantes Cria novo assinante GET
/cobranças Lista cobranças por período ou status POST
/cobranças/pix Emite cobrança PIX GET
/rede/olts Lista OLTs e status de portas POST
/fiscal/nfcom Emite NFCom para assinante Lista completa na documentação de referência .
Primeiros passos
Do sandbox à produção em 4 etapas.
01
Solicite acesso ao sandbox
Preencha o formulário abaixo com seus dados. O acesso ao ambiente de testes é liberado em até 1 dia útil.
02
Explore o ambiente de testes
O sandbox replica o ambiente de produção com dados fictícios. Faça chamadas à API, teste webhooks e valide integrações sem afetar operações reais.
03
Integre com a API
Use a documentação interativa para explorar os endpoints disponíveis — assinantes, cobranças, rede, fiscal e eventos via webhook.
04
Vá para produção
Quando sua integração estiver validada no sandbox, solicite as credenciais de produção ao time técnico da TSMX.
Ambiente Sandbox
Teste sem risco, sem dados reais.
O ambiente sandbox replica integralmente o ambiente de produção com dados fictícios. Todos os endpoints, webhooks e fluxos de cobrança estão disponíveis para teste.
- Dados fictícios isolados de produção
- Webhooks disparados em tempo real
- PIX, boleto e cartão simulados
- Emissão de notas fiscais em modo teste
- Acesso liberado em até 1 dia útil
Credenciais de acesso
URL base
https://sandbox.sgp.net.br/api/v1
Usuário
dev@sandbox
Senha
sandbox2024
Token de exemplo
Bearer sgp_sandbox_xxxxxxxxxxxxxxxx
As credenciais acima são para o ambiente de demonstração aberto. Para obter acesso ao sandbox completo com credenciais individuais, preencha o formulário abaixo.
Solicitar acesso
Acesso individual ao sandbox.
Preencha os dados abaixo. Nossa equipe técnica ativa o acesso e envia as credenciais em até 1 dia útil.
Precisa de ajuda?
Time técnico disponível para integração.
Se precisar de suporte durante o desenvolvimento ou quiser agendar uma sessão técnica com nosso time, é só entrar em contato.