Início Rápido da API do Cliente: Integre a Accplanet /api/v2 em um Único Loop
Se você comprar na Accplanet programaticamente, não precisa de uma API diferente para cada ação. A Customer API usa um único endpoint — POST https://accplanet.com/api/v2 — e um parâmetro action. Este guia é um início rápido prático para que um desenvolvedor possa listar itens do catálogo, verificar estoque, fazer um pedido e consultar o status em uma única sessão.
Accplanet é um marketplace de agregação de fornecedores. Os fornecedores atendem o estoque; a Accplanet oferece descoberta, checkout, rastreamento de pedidos e suporte. Use a API apenas para gerenciamento legítimo de pedidos. Referência completa: Documentação da Customer API.
Em resumo
- Todas as chamadas de cliente vão para
POST /api/v2(sem prefixo/en/) comkey/apikey+action. - Caminho típico:
balance→categories/shops/services→inventory→add→status. - Envie
application/x-www-form-urlencodedou JSON. Nunca coloque chaves em URLs ou no código do front-end. - Respeite
available,min/max, saldo da carteira e HTTP429/Retry-After. - Mantenha a documentação ao vivo aberta enquanto integra — os detalhes dos campos podem evoluir com o catálogo.
Autenticação e endpoint
Crie ou copie sua chave de API de cliente na página de chaves de API do seu perfil na Accplanet e então chame:
POST https://accplanet.com/api/v2
{
"key": "SUA_CHAVE_DE_API",
"action": "categories"
}
Ações suportadas: categories, shops, services, inventory, add, status, balance.
Etapas de integração
Pare quando cada etapa retornar uma resposta limpa antes de prosseguir.
1 · Primeiro
Confirme o saldo
action=balance retorna o balance da carteira e a currency (USD). Faça uma recarga no painel se o saldo não cobrir um pedido de teste.
2 · Recomendado
Descubra a estrutura do catálogo
action=categories retorna categorias pai e nomes de subcategorias. Use essas strings exatas depois como filtros category / subcategory em services.
action=shops lista lojas públicas de fornecedores. Passe o ObjectId shop de uma loja para services quando quiser apenas uma vitrine.
3 · Recomendado
Liste serviços (produtos)
action=services retorna itens vendáveis com ID de service, rate, stock, available, min/max e filtros opcionais (shop, category, entityType, sort, language, paginação). Prefira available=true e estoque que atenda ao min antes de pedir.
4 · Recomendado
Reverifique o inventário
action=inventory com um ID de service ou IDs separados por vírgula (máx. 50) confirma o estoque ao vivo. Útil logo antes de add em SKUs populares.
5 · Faça e acompanhe
Adicione o pedido e depois consulte o status
action=add com service e quantity cobra da carteira e retorna order, charge, currency (HTTP 201). Consulte action=status com esse ID de order para progresso e payload entregue quando concluído.
| Ação | Tarefa | Campos obrigatórios |
|---|---|---|
balance |
Verificação da carteira | key |
categories / shops |
Descoberta | key |
services |
Catálogo + preços | key (+ filtros opcionais) |
inventory |
Instantâneo de estoque | key, service |
add |
Criar pedido | key, service, quantity |
status |
Leitura de atendimento | key, order |
Receitas curl prontas para copiar
# Saldo
curl -X POST https://accplanet.com/api/v2 -d "key=SUA_CHAVE_DE_API" -d "action=balance"
# Página de serviços
curl -X POST https://accplanet.com/api/v2 \
-d "key=SUA_CHAVE_DE_API" -d "action=services" -d "page=1" -d "limit=50"
# Inventário
curl -X POST https://accplanet.com/api/v2 \
-d "key=SUA_CHAVE_DE_API" -d "action=inventory" -d "service=10042"
# Adicionar pedido
curl -X POST https://accplanet.com/api/v2 \
-d "key=SUA_CHAVE_DE_API" -d "action=add" -d "service=10042" -d "quantity=1"
# Status
curl -X POST https://accplanet.com/api/v2 \
-d "key=SUA_CHAVE_DE_API" -d "action=status" -d "order=SEU_ID_DE_PEDIDO"
Substitua os placeholders pela sua chave, um service real de services e o order retornado por add. Comece com quantidade 1 em um item de teste de baixo custo.
Erros e limites de taxa
- Credenciais inválidas → HTTP
401com{"error":"Invalid API key"}. - Problemas de validação / estoque / saldo → geralmente HTTP
400com uma única stringerror(ex.: estoque ou saldo insuficiente). - Limite de taxa → HTTP
429comRetry-After. Recue e tente novamente. - O tamanho padrão da página de serviços é 50 ao paginar; use
limit=0apenas quando quiser intencionalmente a lista completa.
Preços, estoque e disponibilidade mudam com listagens ao vivo. Sempre releia services / inventory antes de compras automatizadas.
Checklist do comprador
- [ ] Chave da API armazenada em um gerenciador de segredos do servidor
- [ ]
balanceOK para um pequeno pedido de teste - [ ] Escolhido um
servicecomavailable=true - [ ] Quantidade dentro de
min/max - [ ] ID de
orderdeaddpersistido estatusconsultado - [ ] Tratados
429e erros de carteira no código
Próximo passo: abra a documentação da Customer API, execute o Test API uma vez e depois conecte as mesmas ações ao seu backend. Fornecedores que integram sincronização de catálogo devem ler o guia complementar para fornecedores no blog da Accplanet.
FAQ
O caminho tem prefixo de idioma?
Não. Use https://accplanet.com/api/v2 — não /en/api/v2.
O que identifica um produto ao pedir?
O campo service de services (ID numérico do catálogo quando atribuído, caso contrário uma string do sistema). Passe o mesmo valor para inventory e add.
Posso filtrar por loja ou categoria?
Sim. Use nomes de categories e o ObjectId shop de