Introdução

Referência da API de integração

Documentação da API pública GateKeeper: login, registro, refresh, /me, login social, senha, integration plans e authorize.

A API de integração fica em https://api.gatekeeperid.cloud. Todas as rotas públicas usam o prefixo /sdk/integration/v1/ e o header X-GK-Tenant-ID (UUID ou slug do tenant).

Discovery

GET /sdk/integration/v1/.well-known/gatekeeper-config — retorna URLs e capacidades da plataforma (sem autenticação).

Autenticação (e-mail e senha)

Em /me, envie também Authorization: Bearer <token>.

  • POST /login — login com tenant header
  • POST /register — cadastro de usuário final
  • POST /refresh-token — renovar sessão
  • POST /logout — encerrar sessão
  • GET /me — perfil do usuário autenticado

Login social (Google)

Fluxo: start → redirect OAuth → exchange com o code retornado.

  • GET /social/{provider}/start?redirect_uri=...
  • POST /social/{provider}/exchange

Senha e conta

  • POST /password/forgot
  • POST /password/change (tenant + Bearer)
  • POST /password/reset
  • POST /account/delete (tenant + Bearer)

Integration plan

O client_secret não é enviado pela SDK nas chamadas de runtime — fica no backend da sua aplicação.

Authorize (runtime)

POST /authorize — valida se o token tem permissão para o método e path informados. Retorna 200 ou 403 ACCESS_DENIED.

Próximos passos

Integre com a SDK Java, explore a especificação OpenAPI ou volte ao guia rápido na landing.