Synup Developer API

A API REST da Synup permite que seus próprios aplicativos leiam e escrevam dados de agência, clientes e locais em seu nome — os mesmos dados que sua equipe vê na Synup, agora disponíveis para o seu próprio código.

REST sobre HTTPS

URLs de recursos previsíveis, corpos JSON, verbos e códigos de status padrão.

Chave Bearer ou OAuth

Chaves autoemitidas para seus próprios sistemas; OAuth para aplicativos que agem em nome de um usuário.

Limitado por cliente

Uma chave pode ser restrita a clientes específicos — a API aplica isso, não o seu código.

Limites conforme o plano

Por agência, não por chave. Acima do limite, retorna 429 com um cabeçalho Retry-After.

URL base

Toda solicitação nesta referência é relativa a:

https://ai.synup.com/api/v1

Versionamento

Esta é a versão 1 da API. Todos os endpoints têm o prefixo /api/v1. Mudanças incompatíveis serão lançadas como um novo prefixo de versão, nunca como uma alteração silenciosa em /api/v1.

Primeiros passos

Crie uma chave de API em Configurações → Desenvolvedor e depois veja em Autenticação como usá-la.

Testar sua primeira solicitação →