Primeiros passos

Este guia mostra como obter credenciais, gerar um token e consultar informações da loja pela Suitable API.

1. Obtenha as credenciais

No painel da Suitable, acesse a página de Aplicativos no Suitable, e clique em SuitAPI. Escolha um nome para sua integração e clique em Criar chave. Guarde o client_id e o client_secret em um local seguro. O client_secret é exibido apenas uma vez.

Antes de começar, escolha o endereço-base correto. Os ambientes publicados estão listados em Ambientes e versões. Nos exemplos abaixo, API_URL representa esse endereço, sem a barra final.

2. Gere um token de acesso

Troque as credenciais por um token usando POST /api/auth/token/. O endpoint segue o fluxo OAuth 2.0 client credentials, então qualquer biblioteca OAuth 2.0 também funciona:

# Este exemplo usa o ambiente de testes; em produção, use o endereço correspondente.
export API_URL="https://sandbox.suit.com.br"

curl "$API_URL/api/auth/token/" \
  -u "SEU_CLIENT_ID:SEU_CLIENT_SECRET" \
  -d "grant_type=client_credentials"

A resposta contém o token e os metadados da sessão. A forma é semelhante a esta:

{
  "access_token": "<JWT>",
  "token_type": "Bearer",
  "expires_in": 900,
  "scope": "store",
  "session_id": "<UUID-da-sessao>",
  "tenant": "<identificador-da-loja>",
  "environment": "development"
}

O valor de expires_in é o tempo de vida do token em segundos; use o valor recebido, pois ele pode variar entre ambientes. O campo scope informa os escopos concedidos ao token, separados por espaço; consulte Escopos de acesso para saber o que cada um libera.

3. Faça uma chamada autenticada

Envie o token como bearer token nas chamadas aos outros endpoints:

export ACCESS_TOKEN="COLE_AQUI_O_ACCESS_TOKEN_RECEBIDO"

curl "$API_URL/api/store/info/" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Uma resposta 200 traz a configuração da loja em JSON. O token já identifica a loja (tenant) e o ambiente (environment); não é necessário enviar esses dados em cada chamada. Consulte a Referência da API para ver os demais endpoints e seus parâmetros.

Próximos passos

Leia Autenticação e permissões para proteger e renovar tokens.
Consulte Uso, limites e boas práticas antes de integrar listagens.
A especificação OpenAPI desta instância está disponível em $API_URL/openapi.json.

Introdução

Autenticação e permissões