API REST
API REST: o seu catálogo Upsellr, gerido a partir das suas próprias ferramentas.
Crie produtos a partir do seu ERP, envie os ficheiros dos seus fornecedores, lance o enriquecimento e a geração e, depois, leia os conteúdos redigidos para cada canal e cada idioma. Uma API REST documentada, com chaves de permissões limitadas.
- Categoria
- API
- Sentido
- Leitura e escrita
- Versão
- REST v2, especificação OpenAPI
- Chaves
- Até 10 por organização, permissões à escolha
- Idiomas
- Etiquetas em francês, inglês, espanhol e alemão
- Autenticação
- Chave de API no cabeçalho Authorization
- Planos
- Plano Enterprise
- Editor
- Upsellr
01O que a API faz
A Upsellr, a partir das suas próprias ferramentas.
- 01
Crie os seus produtos em lotes
Envie até 100 produtos por chamada. A Upsellr reconhece-os por EAN, SKU ou referência do fabricante e marca: um produto já conhecido não é duplicado, recebe uma nova versão se um valor mudar.
- 02
Leia o seu master data
Campos, listas de valores, categorias e modelos: o que estrutura o seu catálogo lê-se através da API, com as etiquetas no seu idioma.
- 03
Envie os ficheiros dos seus fornecedores
Coloque as suas folhas de cálculo e os seus PDF na biblioteca de ficheiros da Upsellr: até 10 MiB num só envio e, acima disso, em várias partes.
- 04
Lance o enriquecimento e a geração
Inicie um processamento sobre uma seleção, uma pesquisa ou todo o catálogo, até 50 000 produtos: a Lily enriquece o master data, o Max redige as fichas dos seus canais, ou é executado um dos seus workflows.
- 05
Leia os conteúdos gerados
Cada produto devolve o seu master data, os seus valores importados e os seus conteúdos gerados, organizados por canal e por idioma.
- 06
Acompanhe os seus processamentos
Um processamento acompanha-se através da API ou por webhook: concluído, com falha ou parado, a sua ferramenta é avisada.
02Primeiros passos
O seu primeiro pedido em poucos minutos.
- 01
Abra as definições da organização
Secção API e webhooks, reservada a proprietários e administradores.
- 02
Crie uma chave
Escolha as permissões: só leitura, leitura e escrita, ou acesso total. Adicione uma data de expiração e endereços IP autorizados, se pretender.
- 03
Ligue-a à sua ferramenta
É enviada no cabeçalho Authorization de cada chamada.
- 04
Chame a API a partir do seu servidor
Não é chamada a partir de um navegador: as suas chaves ficam do lado do servidor.
- 05
Acompanhe os seus processamentos
Através da API, ou com um webhook que o avisa no fim de cada processamento.
03Recursos
O que a API permite ler e escrever.
| Recurso | Leitura | Escrita |
|---|---|---|
| Produtos | Sim | Sim |
| EAN, SKU e referência do fabricante | Sim | Sim |
| Valores do master data | Sim | Sim |
| Conteúdos gerados, por canal e por idioma | Sim | Não |
| Campos e listas do master data | Sim | Não |
| Ficheiros de origem | Sim | SimAté 10 MiB, ou em várias partes |
| Processamentos de enriquecimento e geração | Sim | Sim |
| Preço |
Compatibilidade e requisitos
- O plano Enterprise
- Uma função de proprietário ou administrador para criar as chaves
- Um servidor para chamar a API, nunca um navegador
- O cabeçalho Authorization: Bearer em cada chamada
- Conselho: uma chave por ferramenta, apenas com as permissões necessárias
O controlo é seu
Chaves sob controlo.
- Permissões por chave: só leitura, leitura e escrita, ou acesso total
- Uma data de expiração e endereços IP autorizados, se pretender
- Limites de chamadas por organização, assinalados quando ultrapassados
- Um identificador de pedido em cada resposta, para o suporte
04Perguntas
Perguntas sobre a API da Upsellr.
A API está incluída no meu plano?
Está reservada ao plano Enterprise. Nos outros planos, a secção API e webhooks está visível, mas bloqueada.
Onde encontro a documentação?
A referência da API é gerada a partir da sua especificação OpenAPI, com exemplos em curl, JavaScript, Python e Ruby.
Quais são os limites de chamadas?
Por organização: 200 leituras e 60 escritas por minuto, e 20 por minuto para as operações pesadas, como a criação de produtos, o envio de ficheiros e o lançamento de processamentos. Acima disso, a API responde 429 com o tempo de espera.
Posso alterar ou eliminar um produto através da API?
Ainda não. Cria produtos, e reenviar um produto existente dá-lhe uma nova versão se um valor mudar. A alteração e a eliminação fazem-se na Upsellr.
Como evito duplicados?
A Upsellr reconhece cada produto pelo seu EAN, pelo seu SKU, ou pela sua referência do fabricante e marca: reenviar o mesmo produto não o duplica.
Posso lançar o enriquecimento a partir da minha ferramenta?
Sim. Lance o enriquecimento, a geração, ambos, ou um dos seus workflows, sobre uma seleção, uma pesquisa ou todo o catálogo, até 50 000 produtos por processamento.
Como sei que um processamento terminou?
Consulte o processamento através da API, ou receba um webhook quando for concluído, falhar ou for parado.
Existe um SDK?
Por enquanto não: a API é uma API REST clássica, e a referência dá exemplos prontos a copiar.
O seu próximo produto
merece mais do que copiar e colar.
Dê à sua equipa de IA os primeiros produtos para trabalhar.
Marcus
Amazon