Autenticação
Todas as rotas /api/client/* exigem o header Authorization: Bearer <token>.
Observação: em caso de erro de autenticação ou limite de consumo, a API retorna um JSON com code e message para orientar o próximo passo.
Passo a passo para conectar
Escolha como você prefere ler a documentação: uma versão não técnica ou técnica.
Conectar (Não técnico)
  1. Pegue sua chave de acesso: você recebe um token (a “chave”) para usar no consumo.
  2. Entre no portal: acesse com seu e-mail e senha e confirme que o acesso foi reconhecido.
  3. Veja o que está liberado: abra APIs e Datasets para entender o catálogo disponível para sua conta.
  4. Explore o catálogo: em APIs, abra a documentação de cada endpoint e envie para o seu time técnico.
  5. Integre no seu sistema: seu sistema chama os endpoints liberados enviando o token no header Authorization: Bearer.
  6. Se aparecer limite excedido: aguarde e tente novamente. Se isso atrapalhar sua operação, peça ajuste de limites.
  7. Opcional: Webhooks: em Webhooks, você pode cadastrar um webhook para receber eventos no seu sistema.
Checklist rápido
Token válido • Ao menos 1 item liberado (API/dataset) • Você sabe o objetivo da integração (o que quer consultar).
Referência
Schemas, enums e contratos para acelerar a integração.
Endpoint de Dados
Use GET /api/client/data/:apiId para receber os registros processados de um API product diretamente — sem gateway adicional. O :apiId é o ID da API listada em APIs. Requer o mesmo token Bearer das demais rotas.
Parâmetros de paginação
ParamDefaultMáximo
page1
limit100500
Campos da resposta
CampoTipoDescrição
recordsarrayRegistros da página atual
totalintegerTotal de registros no MongoDB
pagesintegerTotal de páginas disponíveis
pageintegerPágina atual
truncatedbooleantrue se dataset excede o limite MongoDB
Exemplos
curl
curl -H "Authorization: Bearer <seu_token>" \ "<base_url>/api/client/data/<apiId>?page=1&limit=100"
JavaScript (fetch)
fetch("<base_url>/api/client/data/<apiId>?page=1&limit=100", { headers: { "Authorization": "Bearer <seu_token>" } }).then(r => r.json()).then(data => { console.log(data.records); // array de registros console.log(data.total); // total no MongoDB console.log(data.pages); // páginas disponíveis });
Python (requests)
import requests resp = requests.get( "<base_url>/api/client/data/<apiId>", headers={"Authorization": "Bearer <seu_token>"}, params={"page": 1, "limit": 100} ) data = resp.json() print(data["records"]) # lista de registros print(data["total"]) # total no MongoDB
Erros possíveis
HTTPcodeCausa
403api_not_allowedAPI não habilitada para o seu workspace
422no_datasetAPI sem dataset vinculado
422no_processed_refPipeline ainda não executou para este dataset
503mongo_unavailableDados temporariamente indisponíveis — tente novamente
429rate_limitedLimite de consumo atingido