Começar
API Sellume para integradores
Galerias de imagens e vídeos de produto feitos pelo Sellume, pedidos pelo seu sistema e entregues sem a marca Sellume.
O Sellume produz galerias de imagens (3, 6 ou 10 imagens) e vídeos verticais de produto (Apresentação e CinePremium) para vendedores de marketplace. Esta documentação é para integradores: empresas que oferecem esse resultado aos próprios clientes.
Duas formas de integrar#
| API para ERPs e hubs | Embed para agências | |
|---|---|---|
| Para quem | ERPs, hubs e sistemas com equipe técnica | Agências e empresas sem equipe técnica |
| Como funciona | O seu sistema chama a API e mostra o resultado nas suas telas | O seu cliente usa o app inteiro do Sellume com a sua marca, no seu domínio |
| De onde vêm os dados | Da ficha do produto que você envia (única fonte) | Do Mercado Livre, pelo app do Mercado Livre da sua agência |
| Onde começar | Começar | Embed para agências |
Como a API funciona#
- Conta: você cria uma subconta para cada cliente seu (POST
/contas). - Ficha: envia a ficha do produto com fotos e dados (PUT
/contas/{contaId}/produtos/{codigo}). O Sellume não lê marketplace: a ficha é a única fonte. - Conferência: o Sellume confere se a ficha atende aos requisitos mínimos e diz o que pode ser gerado. É grátis e obrigatória.
- Geração: você pede a galeria ou o vídeo e recebe o resultado por aviso assinado ou consulta.
Sem conferência aprovada, nada é gerado e nada é cobrado.
Ambientes: a chave decide#
O endereço é o mesmo. O prefixo da chave define o ambiente.
| Chave | Ambiente | O que acontece |
|---|---|---|
sk_test_… | Teste, grátis | Devolve mídia de exemplo, no mesmo formato da produção. A conferência roda de verdade, para você ver os requisitos reais. Nenhum crédito é gasto. |
sk_live_… | Produção | Gera de verdade e debita a carteira do integrador. Liberada depois que as 8 etapas do teste ficam verdes. |
Endereço da API#
bash
B=https://api.sellume.com.br/v1O OAuth2 fica em https://api.sellume.com.br/oauth/.... Use sempre este endereço: ele continua o mesmo mesmo que a infraestrutura por trás mude.
Mapa da documentação#
Começar
Produção
- Requisitos da fichaO mínimo de dados e fotos para cada tipo de geração, os campos da ficha e uma ficha completa de exemplo.
- GaleriasComo pedir uma galeria de 3, 6 ou 10 imagens, acompanhar a geração, baixar o resultado e como a cobrança funciona.
- VídeosApresentação e CinePremium, requisitos de cada um, fala automática e o que acontece quando nenhuma fala passa nas travas.
- Edição de imagemTroca de cor e ajuste pontual numa imagem entregue pelo Sellume, mudando só o que foi pedido.
Integração
- Avisos e assinaturaWebhooks assinados com HMAC-SHA256, como conferir a assinatura em Node, PHP e Python, o teste de assinatura, retentativas e eventos.
- Idempotência e limitesIdempotency-Key nos pedidos que gastam crédito, limites por minuto, cabeçalhos de limite, Retry-After e o teste do 429.
- Status da integraçãoAs 8 etapas verificadas automaticamente no ambiente de teste, o pedido de acesso de produção e o registro de chamadas.
- Catálogo de errosTodos os códigos de erro da API, das pendências da conferência, das falhas de entrega de aviso e do OAuth, com causa e como corrigir.
- PilotoO kit do primeiro ERP — checklist, roteiro, métrica de sucesso, o que o Sellume prepara e o que fazer se algo falhar.
Conta
- Planos e cobrançaPlanos de API pagos antes, cota do mês como teto, pacote avulso que não vence, subir de plano na hora (pedido ao suporte), descer no próximo ciclo, atraso e cancelamento.
- Embed para agênciasRevenda o Sellume inteiro com a sua marca e o seu domínio, usando o app do Mercado Livre da sua agência.
Referência
- Referência da APITodas as operações da API v1 e do OAuth — parâmetros, corpo, respostas, escopos e exemplos — geradas do contrato OpenAPI.
- PostmanColeção Postman v2.1 gerada do contrato OpenAPI e ambiente de teste prontos para importar.
- MudançasHistórico datado das mudanças da API e a política de compatibilidade e descontinuação.
Links rápidos#
- Começar em 10 passos, do acesso ao pedido de produção.
- Catálogo de erros, com causa e como corrigir cada código.
- Referência da API, operação por operação.
- Coleção Postman e ambiente de teste prontos para importar.
- Portal do integrador: chaves, avisos, status da integração e plano.