Desenvolvedores

A API pública da ControlResell

Automatize o seu negócio a partir dos seus próprios scripts e ferramentas: leia as suas contas, artigos e conversas com uma chave de API.

A API pública está a ser implementada. Está reservada às subscrições que a incluem e é aberta progressivamente: a página de gestão de chaves ainda não está visível em todas as contas. Sem acesso, a API responde com um erro 402.

Gerar a sua chave de API

As chaves são criadas na aplicação, com a sua sessão. Uma chave não pode criar, listar nem revogar outra chave.

  1. Inicie sessão na aplicação web da ControlResell.
  2. Abra Definições e depois Desenvolvedores.
  3. Crie uma chave: dê-lhe um nome, marque pelo menos um âmbito e, se quiser, uma data de expiração (5 anos no máximo).
  4. Copie o segredo de imediato: só é mostrado uma vez.

Gerir as minhas chaves de API

O segredo começa por cr_live_. Trate-o como uma palavra-passe: a ControlResell guarda apenas uma impressão digital e não o pode mostrar novamente. Em caso de dúvida, revogue a chave e crie outra.

Envie a chave no cabeçalho Authorization de cada chamada. Exemplo para ler o seu perfil:

curl https://api.controlresell.com/api/public/v1/me \
  -H "Authorization: Bearer cr_live_..."

Pode ter no máximo 10 chaves ativas, cada uma revogável a qualquer momento.

Âmbitos disponíveis

  • accounts:read – Leitura das contas de marketplace
  • items:read – Leitura dos artigos e dos seus anúncios
  • items:write – Escrita de artigos
  • orders:read – Leitura de encomendas
  • conversations:read – Leitura de conversas
  • conversations:write – Escrita de conversas

Documentação da API

A referência interativa (Swagger) e a especificação OpenAPI são públicas e geradas a partir da API em produção.

A API tem versões (/api/public/v1). A v1 só evolui por adições; em caso de rutura é aberta uma v2 e a v1 continua disponível pelo menos doze meses após o anúncio.

SDK e CLI oficiais

SDK gerados a partir da especificação e uma CLI, de código aberto no GitHub.

Os pacotes ainda não estão publicados: em breve no npm, PyPI e Maven Central. Entretanto, o código-fonte está disponível no GitHub.