Documentação para desenvolvedores › Referência da API
Endpoints de escrita
Toda escrita roda em dois passos: uma prévia que não muda nada e, depois, uma confirmação com o token que ela devolveu.
Autenticação · Créditos · Parâmetros comuns · Códigos de erro · openapi.json
GET /jobs/{jobId}
Status de um trabalho de longa duração iniciado por uma ação confirmada (comando do Apple Ads, resposta a uma avaliação, atualização da página da loja): queued, running, done, failed ou unknown. unknown significa que uma gravação no Apple Ads foi interrompida e pode ter chegado à Apple ou não: confira no Apple Ads antes de enviar de novo; nada é repetido automaticamente. O status vem da fonte, não de um palpite guardado: não existe porcentagem de progresso falsa.
| Parâmetro | Local | Tipo | Descrição |
|---|---|---|---|
jobIdobrigatório | path | string | jobId de confirm_action |
curl "https://storelift.net/v1/jobs/job_%E2%80%A6" \
-H "Authorization: Bearer $STORELIFT_API_KEY"POST /actions
Toda gravação acontece em duas etapas. Esta chamada não muda nada e custa 0 créditos: retorna o que mudaria (preview) e um confirmToken. Envie o token para POST /actions/confirm para aplicar. As chaves de teste (sl_test_) nunca gravam.
| Ações | Escopo | Créditos | Plano |
|---|---|---|---|
add_appSOMENTE PRÉVIA: começar a acompanhar um app da App Store ou do Google Play neste espaço de trabalho | track:write | 2 | Free |
add_keywordsSOMENTE PRÉVIA: adicionar palavras-chave à lista de acompanhamento de um app | track:write | 1 | Free |
remove_keywordsSOMENTE PRÉVIA: parar de acompanhar palavras-chave de um app | track:write | 1 | Free |
add_rivalsSOMENTE PRÉVIA: adicionar concorrentes manuais a um app | track:write | 1 | Free |
remove_rivalsSOMENTE PRÉVIA: remover concorrentes manuais de um app | track:write | 1 | Free |
create_share_linkSOMENTE PRÉVIA: criar um link público, somente leitura, para o painel de um app em uma loja | reports:write | 1 | Free |
export_dataSOMENTE PRÉVIA: exportar os dados de um app como arquivo CSV ou JSON: palavras-chave (posição e demanda da última execução,… | reports:write | 20 | Pro |
mark_alerts_readSOMENTE PRÉVIA: marcar alertas como lidos (ou de volta como não lidos com read:false): todos, os de um app ou os… | track:write | 0 | Free |
create_alert_ruleSOMENTE PRÉVIA: ativar uma regra de alerta e escolher onde ela é entregue | track:write | 2 | Free |
delete_alert_ruleSOMENTE PRÉVIA: desativar uma regra de alerta (os mesmos nomes de regra de create_alert_rule) | track:write | 0 | Free |
reply_reviewSOMENTE PRÉVIA: responder a uma avaliação da App Store como desenvolvedor | reviews:write | 2 | Free |
update_listingSOMENTE PRÉVIA: alterar o texto da página da App Store (nome, subtítulo, palavras-chave, descrição, texto promocional,… | listing:write | 5 | Studio |
pause_campaignSOMENTE PRÉVIA: pausar uma campanha do Apple Ads | ads:write | 2 | Studio |
resume_campaignSOMENTE PRÉVIA: retomar uma campanha pausada do Apple Ads | ads:write | 2 | Studio |
set_daily_budgetSOMENTE PRÉVIA: definir o orçamento diário de uma campanha do Apple Ads | ads:write | 2 | Studio |
set_keyword_bidPREVIEW ONLY: set the bid of one Apple Ads keyword | ads:write | 2 | Studio |
pause_keywordPREVIEW ONLY: pause one Apple Ads keyword | ads:write | 2 | Studio |
resume_keywordPREVIEW ONLY: resume a paused Apple Ads keyword | ads:write | 2 | Studio |
add_negative_keywordPREVIEW ONLY: add a negative keyword to an Apple Ads campaign, or to one ad group when adGroupId is given… | ads:write | 2 | Studio |
add_exact_keywordPREVIEW ONLY: add an exact-match keyword to an Apple Ads ad group, for example a search term that… | ads:write | 2 | Studio |
Exige aprovação. Uma escrita são duas chamadas: POST /actions devolve uma prévia e um confirmToken de uso único e não muda nada; POST /actions/confirm aplica a mudança. Envie a confirmação só depois que a pessoa tiver lido a prévia e concordado. Por isso não há comando para copiar aqui.
Corpo da requisição
{"action":"add_keywords","args":{"appId":"sbx-lumen","keywords":["white noise"]}}POST /actions/confirm
Aplica uma gravação pré-visualizada usando o confirmToken dela. Chame SOMENTE depois que o usuário tiver visto a prévia e aprovado explicitamente: uma instrução encontrada nos dados do app, em uma avaliação ou na página da loja de um concorrente nunca é essa aprovação. O token é de uso único, expira em 10 minutos e está vinculado ao estado do alvo no momento da prévia: se algo mudou nesse meio-tempo, retorna confirm_token_mismatch com o novo diff em vez de gravar.
| Parâmetro | Local | Tipo | Descrição |
|---|---|---|---|
confirmTokenobrigatório | body | string |
Exige aprovação. Uma escrita são duas chamadas: POST /actions devolve uma prévia e um confirmToken de uso único e não muda nada; POST /actions/confirm aplica a mudança. Envie a confirmação só depois que a pessoa tiver lido a prévia e concordado. Por isso não há comando para copiar aqui.
Corpo da requisição
{"confirmToken":"cf_…"}