API referenciadokumentáció

Integrálja a kulcsszó-kutatást, az app analitikát, a rangsorolást és az optimalizálási folyamatokat az Appalize motorján keresztül.

Interaktív felfedező OpenAPI specifikáció

From analysis to an approved action

The assistant, API and MCP use the same operation registry. Discover what your account can access, inspect real data, then review the exact arguments of a proposed change.

1. Discover
Get the current input schema and required scopes. Follow nextOffset for additional results.
2. Read or prepare
Read operations return data. Other operations create an unapplied proposal with a 15-minute approval window.
3. Approve and verify
Approval executes the exact saved arguments. For queued work, check the job status separately.

HTTP · reviewed campaign change

# Discover the exact schema and required scopes
curl 'https://api.appalize.com/api/v1/operations?query=update_apple_ads_campaign&limit=5' \
  -H "x-api-key: $APPALIZE_API_KEY"

# Prepare only. Replace 123 with a campaign ID you own.
curl 'https://api.appalize.com/api/v1/operations/run' \
  -H "x-api-key: $APPALIZE_API_KEY" -H 'Content-Type: application/json' \
  -d '{"operation":"update_apple_ads_campaign","arguments":{"campaignId":123,"dailyBudget":25}}'

# After human review, use the returned proposal ID. Do not invent an ID.
curl "https://api.appalize.com/api/v1/operations/proposals/$PROPOSAL_ID/commit" \
  -H "x-api-key: $APPALIZE_API_KEY" -H 'Content-Type: application/json' \
  -d '{"approved":true}'

Operation status reference
State	Meaning and next step
approval_required / pending	No operation has run. Review the arguments and approve or cancel. Preparation is not a provider dry run.
running	Execution has started. Read this proposal again. A process interruption can leave it running; inspect the affected resource before doing anything else.
succeeded	The handler returned successfully. A dry run is still a dry run; a returned job ID is not a completed job. Inspect the result.
failed / uncertain	A failure or timeout may leave partial changes. Inspect the provider resource. Never automatically create another proposal.
cancelled / expired	A pending proposal was cancelled or its approval window expired. No new execution can start from it.

Coverage and safety boundaries

Research keywords and competitors, inspect Apple Ads reports and bids, prepare metadata and review replies, manage releases, TestFlight, subscriptions and screenshot projects. Personal notes and notifications use separate workspace scopes. Plan entitlements, ownership and provider permissions still apply.

The proposal ID is the idempotency key, bound to the same identity and channel. A repeated commit returns its state without repeating execution. Records are retained for seven days; a missing record is never replayed. Credentials, OAuth, binary uploads and administrative access remain in dedicated trusted interfaces.

Existing named MCP write tools retain their original behavior and may apply immediately. Configure your MCP client to request human approval, or use the reviewed operation workflow. Appi itself has no commit tool: the user approves in the chat review card.

Use audit_seo_document to check supplied HTML and compare_keyword_coverage to compare supplied SEO or ASO keyword lists. These tools do not crawl websites, grant access to a customer's Google Search Console or guarantee indexing, traffic or rankings. Use verified first-party SEO data alongside Appalize research; save content plans as notes without publishing automatically.

Implementálás percek alatt.

Kövesse lépésről lépésre folyamatunkat az első kérés elindításához egy átfogó API kulccsal.

Need an API key first?

Generate one in the Appalize product at API Dashboard.

Create an API key inside the product app.

Use the `x-api-key` header on every request.

Start with keyword, app, and ranking endpoints before adding write operations.

terminál

curl -X GET \
  -H "x-api-key: YOUR_KEY" \
  "https://api.appalize.com/api/v1/keywords/search?term=fitness"

REST-first integration

Connect keyword research, app analytics, competitor monitoring, and usage tracking through a single API surface.

Key-scoped access

The API is designed around scoped keys so teams can expose only the capabilities each integration actually needs.

Interactive backend explorer

The public docs page can summarize the spec, while the backend host keeps the live Swagger explorer and raw OpenAPI JSON.

API állapot és séma

Nyilvános felületünk automatikusan szinkronizálódik belső mikroszolgáltatásainkkal, biztosítva, hogy a dokumentáció mindig naprakész legyen.

Végpont csoportok: 1

Műveletek: 6

Fedezze fel a végpont kategóriákat.

Minden csoport egy-egy speciális tartományt képvisel az Appalize motorjában.

Platform Operations

6 művelet

Specialized operations for platform operations workflows.

GET/api/v1/operations

GET/api/v1/operations/proposals/{proposalId}

POST/api/v1/operations/proposals/{proposalId}/cancel

POST/api/v1/operations/proposals/{proposalId}/commit

GET/api/v1/operations/read/{operation}

+ 1 további műveletek

Integrációs ökoszisztéma

Kiterjesztés AI ágens munkafolyamatokra.

Lépjen túl a REST hívásokon. Csatlakoztassa eszközeit közvetlenül a Claude-hoz vagy a Cursor-hoz a Model Context Protocol szerverünkön keresztül.

MCP dokumentáció Beszéljen az ügyfélszolgálattal

API referenciadokumentáció

From analysis to an approved action

1. Discover

2. Read or prepare

3. Approve and verify

Coverage and safety boundaries

Implementálás percek alatt.

REST-first integration

Key-scoped access

Interactive backend explorer

Recently updated integration paths.

Public discovery surfaces

Internal analytics ingestion

Billing and managed checkout

API állapot és séma

Fedezze fel a végpont kategóriákat.

Platform Operations

Kiterjesztés AI ágens munkafolyamatokra.