Utilizar a API pública

A API pública da Upsellr dá acesso à sua master data, aos seus produtos, às suas fontes e aos seus workflows a partir das suas próprias ferramentas. Está incluída no plano Enterprise.

O essencial

• Endereço base: https://api.upsellr.io/v2
• Autenticação: cada pedido leva o cabeçalho Authorization com o valor Bearer seguido da sua chave. Ver criar e gerir chaves API.
• Documentação: a referência completa, com exemplos, está publicada em docs.upsellr.io.

Chamadas apenas a partir de um servidor

A API chama-se a partir de um servidor, nunca a partir de um navegador: não responde a pedidos enviados por uma página web. Isto evita também expor a sua chave no código de uma página.

Os limites de débito

Os limites aplicam-se à organização inteira, somando todas as chaves.

Tipo de pedido	Por minuto	Rajada
Leituras	200	30
Escritas	60	10
Escritas pesadas: criação de produtos, depósito de ficheiro, lançamento de workflow	20	5
Pesquisa e leitura de produtos	60	5

Acima disso, a API responde com o código 429 e um cabeçalho Retry-After que indica, em segundos, quando tentar novamente.

Identificador de pedido

Cada resposta leva um cabeçalho X-Request-Id. Se um pedido falhar de forma inesperada, anote esse identificador e transmita-o ao suporte: permite encontrar exatamente a sua chamada.

Bom saber

• Uma chave limitada a certos endereços IP ou certos User-Agents é recusada a partir de qualquer outra origem.
• Demasiados pedidos com uma chave inválida a partir de um mesmo endereço provocam um bloqueio temporário, assinalado por um código 429.
• Uma chave só atua dentro dos limites dos seus âmbitos: um pedido fora do âmbito é recusado.
• Lançar um workflow através da API consome créditos tal como a partir da aplicação.
• Para ser avisado do fim de uma execução sem consultar a API repetidamente, utilize os webhooks.
• Uma questão? Utilize contacte-nos ou o botão Report a bug na aplicação, com o identificador de pedido.