Primeiros Passos

O Mercury é a plataforma de pagamentos e assinaturas da Wiser: processa cobranças, gerencia assinaturas e faturas, e captura leads e vendas para os produtos educacionais da empresa. Esta API pública é a forma da sua integração criar contatos e leads, gerenciar assinaturas e faturas, e processar pagamentos, de ponta a ponta.

Este guia leva você da criação das credenciais até a sua primeira chamada autenticada à API do Mercury.

Visão geral do fluxo

Obtenha suas credenciais de acesso (clientId e clientSecret).

Troque as credenciais por um token de acesso em POST /v1/token.

Faça a primeira chamada autenticada enviando o token no header Authorization: Bearer.

Consulte a referência completa da API para os demais endpoints.

1. Credenciais de acesso

O acesso à API é feito com um par clientId / clientSecret, específico para cada ambiente (produção ou sandbox). Nos próximos passos você verá como trocar essas credenciais por um token — o guia de Autenticação traz o detalhe de como obter suas credenciais e como funciona o fluxo por trás do token.

2. Trocar credenciais por um token

Envie suas credenciais para POST /v1/token. A resposta contém um access_token válido por 15 minutos, que você usará nas chamadas seguintes.

Resposta (exemplo):

{
  "access_token": "eyJhbGciOiJFUzI1NiI..."
}

O endpoint POST /v1/token é o ponto de entrada do fluxo e não exige permissão. Todos os demais endpoints exigem o token obtido aqui. Detalhes do modelo de autenticação e das permissões estão em Autenticação.

3. Primeira chamada autenticada

Envie o access_token no header Authorization: Bearer <access_token>. O exemplo abaixo cria um lead — name, email, phone e seller são obrigatórios:

Resposta (exemplo):

{
  "leadId": "ld_123"
}

Se a chamada retornar 403, é porque seu token não tem a permissão necessária para essa operação — veja Autenticação para entender como as permissões funcionam.

4. Ler a referência

Esta documentação traz a referência completa da API, organizada por recurso (Contatos, Leads, Links de Pagamento Personalizados). Para cada endpoint você encontra:

método e path;

parâmetros de path e corpo da requisição (quando aplicável);

respostas e formatos de erro;

as permissões exigidas para autorizar a chamada.

Não há SDKs oficiais — a integração é feita via chamadas HTTP/REST diretas, usando o cliente HTTP da sua preferência.

Versionamento

Todos os endpoints são versionados por path (/v1/...). Ainda não há um changelog público nem uma política formal de depreciação documentada — mudanças que quebrem compatibilidade seriam comunicadas por outro canal, a definir.

Próximos passos

Autenticação — fluxo de token, uso do Bearer e permissões.

Ambientes — produção e sandbox.

Erros — formato padrão de erro e status codes possíveis.

Limites de Requisição — limites de requisições por segundo.

Visão geral do fluxo#

1. Credenciais de acesso#

2. Trocar credenciais por um token#

3. Primeira chamada autenticada#

4. Ler a referência#

Versionamento#