Artigo: Atualizações e Alterações nas Rotas da API Pública

Nos últimos dias, nossa API pública passou por diversas mudanças que afetam diretamente o consumo e a estrutura das rotas disponíveis. Embora a documentação já atualizada reflita as novas práticas, algumas diferenças significativas entre o ambiente de produção e o novo padrão implementado foram observadas.

Essas mudanças visam adequar a API às melhores práticas e aprimorar a experiência dos desenvolvedores.

Aqui está uma análise detalhada das mudanças, destacando o antes e o depois das rotas da API.

1. Padronização dos Métodos HTTP

No ambiente anterior de produção, todas as rotas de acesso aos dados utilizavam o método POST, independentemente da operação realizada. Agora, com a atualização, as rotas utilizam o método correto para cada tipo de operação, alinhando-se às práticas RESTful.

Mudança Geral

• Antes (Produção): Todas as rotas utilizavam POST, inclusive para acessos simples.
• Agora (Atualização):
• Rotas de leitura utilizam o método GET.
• Rotas de criação/manipulação permanecem com o método POST.

2. Nova Rota para Billing (Cobranças)

Uma das mudanças mais significativas foi a transição do recurso Billing para Payments/Charges.

Com isso, o endpoint se tornou mais claro e a rota principal foi simplificada para facilitar o consumo.

Mudanças nos Endpoints

Novos Endpoints

GET /api/v1/solar/payments/charges/{charge_id}

Retorna os detalhes de uma cobrança específica pelo seu ID.

Parâmetros

Exemplo de Requisição

GET /api/v1/solar/payments/charges/6DKqgxpQEzLPxZVmlzrRa

Campos Renomeados

Campos Adicionados

3. Alteração nas Rotas de CRM

Os endpoints de CRM também foram atualizados com a introdução dos métodos corretos. As consultas foram alteradas para GET, alinhando-se à diferenciação entre leitura e criação.

Tabelas Resumo

Rotas de Criação

As rotas responsáveis por criação não sofreram alterações:

• POST /api/v1/crm/people/create
• POST /api/v1/crm/company/create

4. Mudanças nos Endpoints Solares

Os módulos solares (como Usinas e Clientes) também receberam ajustes. As rotas de consulta foram alteradas para GET, mantendo o padrão de acesso RESTful.

Rotas Ajustadas

A rota de criação de clientes permaneceu inalterada:

• POST /api/v1/solar/customers/create

5. Endpoint de Tickets

Para os Tickets, houve uma mudança no método de consulta. A rota agora utiliza GET para recuperar chamados ou tickets registrados na organização.

• Antes (Produção):
• POST /api/v1/ticket
• Agora (Atualização):
• GET /api/v1/ticket

6. Vantagens das Atualizações

• Consistência:

Agora, há uma diferença clara entre rotas de leitura (GET) e rotas de alteração/criação (POST), alinhando a API às melhores práticas RESTful.

• Clareza:

O renomeamento de Billing para Payments/Charges fornece maior contexto.

• Facilidade:

Ajustes estruturais permitem uma integração mais padronizada e intuitiva, especialmente se novos endpoints forem adicionados no futuro.

7. Resumo Final

Explore todas as mudanças diretamente na Documentação da API.

Conclusão

As atualizações na API marcam um progresso importante, alinhando-a com as melhores práticas do mercado. Recomendamos que os desenvolvedores revisem suas integrações existentes e realizem as alterações necessárias para garantir compatibilidade.

Atualizado em: 24/03/2026