API REST

Início rápido

Crie links com resposta imediata e colete um lote com curl.

1. Obtenha as credenciais

Crie uma chave de API pessoal em Conta → Indicações → Chaves de API. Copie-a quando for exibida e forneça-a ao seu script como NINJABUY_API_KEY; mantenha-a privada.

Para um aplicativo que atua por outros clientes da NinjaBuy, use OAuth.

curl -sS https://www.ninjabuy.com/api/v1/links \
  -H "Authorization: Bearer $NINJABUY_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{"links":["https://weidian.com/item.html?itemID=7581746714"],"campaign":"spring-haul","label":"video 3"}'

Até 100 entradas retornam 200 com results, warnings e request_id. Cada resultado tem input e status; um resultado ok inclui a url com atribuição e o code. Confira cada linha: sucesso HTTP não significa que todas as entradas foram convertidas. Veja Links.

3. Inicie um lote

Mais de 100 entradas são processadas automaticamente em segundo plano, com até 2.000 por solicitação. Para testar uma tarefa com um link, defina async como true:

curl -sS -D batch-headers.txt https://www.ninjabuy.com/api/v1/links \
  -H "Authorization: Bearer $NINJABUY_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{"links":["https://www.ninjabuy.com/search?q=hoodie"],"async":true}'

A resposta é 202. Location fornece um caminho relativo como /api/v1/jobs/JOB_ID; Retry-After: 5 indica quando consultar. O corpo contém job.id, job.status, job.total e job.poll_after_seconds.

4. Leia os resultados por cursor

Use o identificador da tarefa retornado nessa resposta. Omita cursor na primeira solicitação:

curl -sS "https://www.ninjabuy.com/api/v1/jobs/JOB_ID" \
  -H "Authorization: Bearer $NINJABUY_API_KEY"

Em cada solicitação seguinte, envie o cursor não nulo retornado sem alterá-lo:

curl -sS "https://www.ninjabuy.com/api/v1/jobs/JOB_ID?cursor=RETURNED_CURSOR" \
  -H "Authorization: Bearer $NINJABUY_API_KEY"

Leia os results de cada página. Quando has_more for true, busque a próxima página. Quando for false, mas a tarefa estiver queued ou running, espere poll_after_seconds e consulte com o cursor guardado. Pare quando a tarefa estiver done ou failed e todas as páginas tiverem sido lidas. Veja Tarefas e Erros.

Próximos passos

Converta uma planilha do Google ou um arquivo XLSX/CSV enviado com Planilhas, ou encontre produtos com Busca.