FastCall API de Integracao

Autenticacao

Use POST /api/v1/oauth/token com grant_type=client_credentials, client_id e client_secret. O token retornado deve ser enviado em Authorization: Bearer <token>.

{
  "grant_type": "client_credentials",
  "client_id": "fc_client_8f3a91d2b7",
  "client_secret": "fc_secret_4aae8fd90d7e4bc1a7a2"
}

Endpoints

POST /api/v1/oauth/token

Gera um access_token JWT valido por 1 hora por padrao.

GET /api/v1/bens/patrimonios/{numero_patrimonio}

Requer bens:read. Retorna valor somente quando o token tambem possui bens:valor:read.

POST /api/v1/bens/consulta-por-colaborador

Requer colaboradores_bens:read. O CPF deve ir no body e a resposta retorna apenas CPF mascarado.

Rate limit

Os limites por minuto e por dia sao definidos por credencial em tb_api_clientes.rate_limit_minuto e tb_api_clientes.rate_limit_dia. Quando o limite e excedido, a API retorna 429 RATE_LIMIT_EXCEEDED.

Padrao de erros

{
  "error": {
    "code": "FORBIDDEN_SCOPE",
    "message": "Credencial sem permissao para acessar este recurso.",
    "request_id": "req_9a74b2d2f60e42d6b1f8e42d0b795f51"
  }
}

Seguranca e LGPD

A API nao aceita id_grupo por body, query string ou header. O grupo vem somente do JWT validado. Logs nao gravam client_secret, access_token completo, CPF puro ou body completo.

OpenAPI

O contrato completo esta disponivel em openapi.yaml.

Abrir openapi.yaml

Resumo carregado

Carregando openapi.yaml...