Serviços / Plataforma

Ping de integração

GET/api/v1/ping/billable

Confirma que a chave, o projeto e o saldo estão prontos, sem executar nenhum serviço.

Chame com a chave de API, sem parâmetros. Com a chave de teste, envie dev_mode=true e nada é cobrado.

Fonte: Plataforma ApiForDevs · tempo real

Parâmetros

Esta rota não exige parâmetros.

Campos da resposta

Pong

pong

boolean

Serviço

service

string

Projeto

project

string

Exemplo de resposta

Modelo de resposta: Pong
JSON · response
{
  "success": true,
  "code": 200,
  "code_message": "A requisição foi processada com sucesso.",
  "errors": [],
  "header": null,
  "data_count": 1,
  "data": [
    {
      "pong": true,
      "service": "platform/ping",
      "project": "proj_a1b2c3d4"
    }
  ]
}

Casos de uso

Validação de integração

Primeira chamada do dev: confirma credencial, projeto e conectividade com um custo simbólico.

Monitoramento do cliente

Sonda periódica que prova que a chave continua válida e com saldo.