Autenticação e limites de uso

Autenticação

Toda solicitação para /api/v1/* é autenticada com uma chave de API, enviada como token Bearer no cabeçalho Authorization:

Authorization: Bearer sy_...

As chaves de API começam com sy_ e são exibidas por completo apenas uma vez — no momento em que você as cria. Depois disso, você só verá os quatro primeiros e os quatro últimos caracteres. As chaves expiram após 30, 90 (padrão) ou 365 dias; usar uma chave expirada retorna 401.

Crie uma chave em Configurações → Desenvolvedor → Chaves de API. Cada chave recebe um modelo de permissões e uma configuração de acesso a clientes:

Somente leitura — Leitura em todos os recursos — sem escrita, sem publicação.

Acesso completo — Leitura e escrita em tudo, incluindo publicação e gestão de equipe. Reserve isso para sistemas totalmente sob seu controle.

Personalizado — Escolha leitura, leitura e escrita, ou nenhum acesso para cada recurso. Você verá a lista completa ao criar a chave.

Todos os clientes — A chave pode acessar todos os clientes da sua agência, incluindo os que você adicionar depois.

Clientes específicos — A chave fica limitada a uma lista fixa de clientes que você escolhe na criação. Solicitações para qualquer outro cliente retornam 403.

Limites de uso

Os limites de uso são por agência, não por chave, e variam conforme o seu plano. Se não souber qual é o seu, fale com sua equipe de conta.

Se você exceder o limite, receberá uma resposta 429 com um cabeçalho Retry-After indicando quantos segundos aguardar antes de tentar novamente.

Toda resposta de erro inclui um campo error descrevendo o que aconteceu. Alguns tipos de erro incluem campos adicionais com mais detalhes:

{
  "error": "locationId is required"
}

Códigos de status