Quickstart

This guide takes you from credentials to your first successful API call.

Prerequisites

A Portão 3 API client. Your account manager provides its API client credentials (client_id / client_secret).
Your realmId and organizationId, shared during onboarding. Tenant-scoped endpoints require both in the path.

Step 1: Get an access token

Authenticate against the Identity service with your API client credentials. Send your client_id and client_secret as HTTP Basic credentials, and set grantType to client_credentials in the body:

# base64-encode the credentials; tr -d '\n' strips any line wrapping GNU base64 adds
BASIC_AUTH=$(printf '%s' "$CLIENT_ID:$CLIENT_SECRET" | base64 | tr -d '\n')

curl -X POST https://api.identity.v2.portao3.com.br/auth/sign-in \
  -H "Authorization: Basic $BASIC_AUTH" \
  -H "Content-Type: application/json" \
  -d '{ "grantType": "client_credentials" }'

A successful sign-in returns your tokens:

{
  "accessToken": "eyJraWQiOi...",
  "idToken": "eyJraWQiOi...",
  "refreshToken": "eyJjdHkiOi..."
}

Use the accessToken as your bearer token on every API request.

Step 2: Make your first call

Verify the token by fetching the identity it belongs to:

curl https://api.identity.v2.portao3.com.br/me \
  -H "Authorization: Bearer $ACCESS_TOKEN"

A 200 response confirms your token works.

Step 3: Call a tenant-scoped endpoint

Most endpoints are scoped to your realm and organization. For example, list your billing deals:

curl "https://api.billing.v2.portao3.com.br/realms/$REALM_ID/organizations/$ORG_ID/deals" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

If you get a 403, check that the realmId and organizationId in the path match the tenant your credentials belong to.

Step 4: Renew your token

Access tokens are short-lived. When one expires, request a new one by repeating Step 1 with your client credentials.

Next steps

Browse the API Reference

Every endpoint across all Portão 3 services, with schemas and examples.

Get support

Questions about credentials, tenancy, or a specific endpoint? We can help.

Stuck? Email suporte@portao3.com.br and include the traceId from any error response.

Getting Started

Integration guides

Cards

PIX & payments

Accounts & wallets

Building your integration

Prerequisites

Step 1: Get an access token

Step 2: Make your first call

Step 3: Call a tenant-scoped endpoint

Step 4: Renew your token

Next steps

Browse the API Reference

Get support

​Prerequisites

​Step 1: Get an access token

​Step 2: Make your first call

​Step 3: Call a tenant-scoped endpoint

​Step 4: Renew your token

​Next steps

Browse the API Reference

Get support

Prerequisites

Step 1: Get an access token

Step 2: Make your first call

Step 3: Call a tenant-scoped endpoint

Step 4: Renew your token

Next steps