Pular para o conteúdo principal

Guia de Início Rápido

Este guia vai te ajudar a fazer sua primeira requisição à API da Catalisa Platform em menos de 5 minutos.

Pré-requisitos

  • client_id (ID da sua organização)
  • client_secret (chave secreta da organização)
informação

Se você ainda não possui as credenciais, entre em contato com o administrador da plataforma.

Passo 1: Obter Token de Acesso

Primeiro, você precisa obter um token de acesso usando o fluxo Client Credentials.

curl -X POST 'https://iam.stg.catalisa.app/oauth/token' \
-H 'Content-Type: application/json' \
-d '{
"grant_type": "client_credentials",
"client_id": "2194956a-2d0a-4203-89a3-933319d80fa1",
"client_secret": "seu-client-secret"
}'

Resposta

{
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"token_type": "Bearer",
"expires_in": 3600
}
dica

Guarde o access_token - você vai precisar dele em todas as requisições subsequentes.

Passo 2: Fazer uma Requisição

Agora que você tem o token, pode fazer requisições aos Building Blocks. Vamos listar os produtos disponíveis:

curl -X GET 'https://products.stg.catalisa.app/api/v1/products' \
-H 'Authorization: Bearer SEU_ACCESS_TOKEN' \
-H 'Content-Type: application/json'

Resposta

{
"data": [
{
"type": "products",
"id": "550e8400-e29b-41d4-a716-446655440000",
"attributes": {
"name": "Empréstimo Pessoal",
"productType": "PERSONAL_LOAN",
"active": true
}
}
],
"meta": {
"totalItems": 1,
"totalPages": 1,
"currentPage": 1
}
}

Passo 3: Criar um Recurso

Vamos criar uma pessoa no módulo Customers:

curl -X POST 'https://customers.stg.catalisa.app/api/v1/people' \
-H 'Authorization: Bearer SEU_ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"type": "people",
"attributes": {
"name": "Joao da Silva",
"taxId": "123.456.789-00",
"email": "joao@exemplo.com"
}
}
}'

Próximos Passos

Agora que você fez sua primeira requisição, explore os demais recursos:

  • Autenticação - Aprenda mais sobre OAuth 2.0 e refresh tokens
  • Paginação - Entenda como paginar resultados
  • Erros - Conheça os códigos de erro da API

Building Blocks