Referência técnica

Documentação das APIs

Referência oficial dos endpoints da Plataforma NEXACT para NEXACT ID, licenciamento, dispositivos, downloads, releases, feedback, administração e observabilidade.

TodasAdministraçãoDispositivosDownloadsFeedbackLicenciamentoNEXACT IDObservabilidadeOrganizaçõesProdutosReleasesUsuários
POSTNEXACT ID

/api/v1/nexact-id/register

Cria uma conta NEXACT ID.

Parâmetros

  • Nenhum parâmetro de URL.

Resposta

Usuário, sessão e tokens.

HTTP: 200, 400, 409, 429

{ "ok": true, "data": { "user": {}, "tokens": {} } }
{ "ok": false, "error": { "code": "CONFLICT" } }
POSTNEXACT ID

/api/v1/nexact-id/login

Autentica usuário por e-mail e senha.

Parâmetros

  • Nenhum parâmetro de URL.

Resposta

Perfil autenticado, sessão e par de tokens.

HTTP: 200, 400, 401, 429

{ "ok": true, "data": { "tokenType": "Bearer" } }
{ "ok": false, "error": { "code": "UNAUTHORIZED" } }
POSTNEXACT ID

/api/v1/nexact-id/session/refresh

Renova uma sessão ativa.

Parâmetros

  • Refresh token válido.

Resposta

Novo access token e refresh token.

HTTP: 200, 401

{ "ok": true, "data": { "tokens": {} } }
{ "ok": false, "error": { "code": "UNAUTHORIZED" } }
GETUsuários

/api/v1/users

Lista usuários autorizados para o consumidor atual.

Parâmetros

  • page
  • limit
  • q
  • sort
  • order

Resposta

Lista paginada de usuários.

HTTP: 200, 401, 403

{ "ok": true, "data": [] }
{ "ok": false, "error": { "code": "FORBIDDEN" } }
GETOrganizações

/api/v1/organizations

Lista organizações/workspaces disponíveis.

Parâmetros

  • page
  • limit
  • q

Resposta

Lista de organizações.

HTTP: 200, 401

{ "ok": true, "data": [] }
{ "ok": false, "error": { "code": "UNAUTHORIZED" } }
GETProdutos

/api/v1/products

Lista produtos, aplicativos e serviços oficiais.

Parâmetros

  • page
  • limit
  • q
  • category
  • status

Resposta

Catálogo central de produtos.

HTTP: 200, 400

{ "ok": true, "data": [] }
{ "ok": false, "error": { "code": "VALIDATION_ERROR" } }
POSTLicenciamento

/api/v1/licensing/validate

Valida licença, plano, produto, dispositivo e recursos.

Parâmetros

  • Authorization: Bearer <token>

Resposta

Decisão de licenciamento e recursos liberados.

HTTP: 200, 400, 401, 403

{ "ok": true, "data": { "allowed": true } }
{ "ok": false, "error": { "code": "FORBIDDEN" } }
POSTDispositivos

/api/v1/devices

Registra dispositivo autorizado na conta.

Parâmetros

  • Authorization: Bearer <token>

Resposta

Dispositivo registrado ou atualizado.

HTTP: 200, 400, 401, 409

{ "ok": true, "data": { "activationStatus": "ACTIVE" } }
{ "ok": false, "error": { "code": "CONFLICT" } }
GETDownloads

/api/v1/downloads

Lista instaladores, atualizações e materiais oficiais.

Parâmetros

  • product
  • platform
  • channel
  • access
  • q

Resposta

Catálogo de downloads.

HTTP: 200, 400

{ "ok": true, "data": { "recommended": [] } }
{ "ok": false, "error": { "code": "VALIDATION_ERROR" } }
GETReleases

/api/v1/distribution/releases

Lista releases, canais e release notes.

Parâmetros

  • product
  • platform
  • channel

Resposta

Releases disponíveis.

HTTP: 200, 404

{ "ok": true, "data": [] }
{ "ok": false, "error": { "code": "NOT_FOUND" } }
POSTFeedback

/api/v1/feedbacks

Recebe feedbacks, bugs e sugestões dos produtos.

Parâmetros

  • Authorization opcional.

Resposta

Feedback registrado.

HTTP: 200, 400

{ "ok": true, "data": { "status": "NEW" } }
{ "ok": false, "error": { "code": "VALIDATION_ERROR" } }
GETAdministração

/api/admin/overview

Visão executiva e operacional do NEXACT Admin.

Parâmetros

  • Authorization: Bearer <token admin>

Resposta

Indicadores administrativos.

HTTP: 200, 401, 403

{ "ok": true, "data": { "metrics": [] } }
{ "ok": false, "error": { "code": "FORBIDDEN" } }
GETObservabilidade

/api/admin/observability

Dashboard de saúde, métricas, logs e alertas.

Parâmetros

  • Authorization: Bearer <token admin>

Resposta

Estado operacional da plataforma.

HTTP: 200, 401, 403

{ "ok": true, "data": { "health": {} } }
{ "ok": false, "error": { "code": "FORBIDDEN" } }