Como consumir as rotas disponibilizadas na API PÚBLICA



API Pública: integração simples e segura com nossos serviços


Entenda por que disponibilizamos uma API pública:

Com o objetivo de facilitar integrações e ampliar as possibilidades de uso da plataforma, disponibilizamos uma API pública que permite que desenvolvedores e sistemas externos acessem nossos serviços de forma padronizada e segura.


O que é uma API Pública:

Uma API pública é uma interface que permite que aplicações externas se comuniquem com um sistema de maneira estruturada. Na prática, ela possibilita que outras plataformas, softwares ou automações utilizem funcionalidades do nosso sistema sem precisar acessar diretamente a aplicação principal.

A disponibilização de uma API pública tem como principal objetivo permitir integrações mais flexíveis. Empresas e desenvolvedores podem automatizar processos, conectar diferentes sistemas e criar novas soluções utilizando os dados e recursos disponibilizados pela plataforma.

Além disso, a API pública também facilita a escalabilidade das integrações. Em vez de processos manuais ou importações de dados, sistemas podem se comunicar automaticamente, garantindo mais eficiência, consistência e rapidez nas operações.


Como começar a utilizar a API pública:

Para acessar as rotas da API pública, é necessário possuir uma API Key, que funciona como uma chave de autenticação para identificar e autorizar as requisições feitas ao sistema.

O processo para gerar uma API Key é simples:

  1. Acesse o menu **Configurações **da plataforma.


  1. Entre na seção API Keys.

  1. Clique na opção Chave de API habilitada

  1. Após a criação, copie a Chave de API gerada.


Documentação da API

Para facilitar o uso da API pública, disponibilizamos a documentação por meio do Swagger. O Swagger permite visualizar todas as rotas disponíveis, entender quais parâmetros são necessários e até mesmo testar requisições diretamente pela interface.

Com ele, desenvolvedores conseguem explorar a API de forma mais prática, verificando exemplos de requisição, formatos de resposta e detalhes de cada endpoint.

A documentação completa da API pode ser acessada no link abaixo:

https://public-api.gdash.io/swagger

Após gerar sua API Key, basta acessar a documentação no Swagger, inserir a chave nas requisições e começar a utilizar as rotas da API pública para integrar sua aplicação.



Rotas disponíveis na API pública

A API pública disponibiliza endpoints que permitem acessar e manipular dados de diferentes módulos da plataforma, como CRM, faturas, pagamentos e tickets.

CRMTask

Responsável pela consulta de tarefas do CRM vinculadas à organização.

  • GET /api/v1/crm/task

Retorna a lista de tarefas registradas no CRM da organização associada à API Key.


CRMPeople

Permite consultar e cadastrar pessoas no CRM da organização.

  • GET /api/v1/crm/people

Retorna todas as pessoas cadastradas no CRM da organização.

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

Cria um novo registro de pessoa dentro da organização.


CRMDeal

Gerencia oportunidades ou negociações dentro do CRM.

  • GET /api/v1/crm/deal

Retorna todas as negociações (deals) registradas na organização.

  • POST /api/v1/crm/deal/create

Cria uma nova negociação no CRM da organização.


CRMCompany

Permite acessar e cadastrar empresas vinculadas ao CRM.

  • GET /api/v1/crm/company

Retorna todas as empresas cadastradas na organização.

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

Cria uma nova empresa dentro da organização.


Plant

Relacionada às usinas de geração de energia.

  • GET /api/v1/solar/plants

Retorna todas as usinas associadas à organização.


Customer

Gerencia os clientes vinculados no GDASH.

  • GET /api/v1/solar/customers

Retorna todos os clientes da organização.

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

Cria um novo cliente dentro da organização.


Payments

Responsável pelas informações de cobranças e pagamentos.

  • GET /api/v1/solar/payments/charges

Retorna todas as cobranças registradas na organização associada à API Key.

Este endpoint também permite o uso de filtros para refinar a busca das cobranças e paginação, possibilitando que os resultados sejam retornados em partes, facilitando o consumo da API em grandes volumes de dados.

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

Retorna os detalhes de uma cobrança específica a partir do ID da cobrança.


EnergyBilling

Permite consultar faturas ou registros de faturamento de energia.

  • GET /api/v1/solar/energy-billing

Retorna as faturas ou registros de faturamento de energia da organização.


Ticket

Relacionada ao sistema de chamados.

  • GET /api/v1/ticket

Retorna todos os tickets ou chamados registrados na organização.



Exemplo em TypeScript

Segue um exemplo simples de uso da API em TypeScript, fazendo uma requisição para buscar cobranças:

const API_KEY = 'SUA_API_KEY';
const BASE_URL = 'https://public-api.gdash.io/api/v1/solar/payments/charges';

async function getCharges() {
  const cursor = '2025-01-01T00:00:00Z';
  const limit = 10;

  const response = await fetch(
    `${BASE_URL}?apikey=${API_KEY}&cursor=${encodeURIComponent(cursor)}&limit=${limit}`,
    {
      method: 'GET',
      headers: {
        'Content-Type': 'application/json',
      }
    }
  );

  const data = await response.json();
  console.log(data);
}

getCharges();

Atualizado em: 24/03/2026

Este artigo foi útil?

Compartilhe seu feedback

Cancelar

Obrigado!