App Store Server API | Operate As Docs

Connect your client's App Store Server API with a key they paste, and call its API through Operate As.

Website: developer.apple.com/documentation/appstoreserverapi
Connects by: Pasting a In-app purchase private key
Category: Payments
Services: 1
Tools: Pass-through only

Service	Key	Base URL
App Store Server API	`app-store-server`	`https://api.storekit.itunes.apple.com`

Your client also types their issuer id (Above the list of keys in Users and Access, Integrations, In-App Purchase) and key id (Beside the in-app purchase key in Users and Access, Integrations) and bundle id (Your app's bundle ID, such as com.example.app).

Connecting

Your client makes a In-app purchase private key in their App Store Server API settings and pastes it on their link. Operate As tries it with App Store Server API before saving it, and stores it encrypted. See Services connected with an API key.

Check they're connected

curl https://api.operate.as/v1/me/clients \
  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

curl https://api.operate.as/v1/me/clients \  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

Response

[
  {
    "id": "6f1c2a7e-...",
    "name": "Miller Dental",
    "services": [
      "app-store-server"
    ]
  }
]

[  {    "id": "6f1c2a7e-...",    "name": "Miller Dental",    "services": [      "app-store-server"    ]  }]

Permissions

What the client reads	Permission it asks for
Use the App Store Server API key you paste, with only the access you gave that key	Chosen on the provider's screen

Pass-through

App Store Server API has no ready-made tools yet. Call any endpoint of its API through Operate As instead, with the client's access attached.

Add the client

In Clients, add your client and select App Store Server API. Then send them their link.

Your client connects

They paste a In-app purchase private key from their App Store Server API settings.

Find the endpoint

Pick the call from App Store Server API's own API docs. Your path is everything after https://api.storekit.itunes.apple.com.

Send it through Operate As

Use the client's ID, the service key app-store-server and that path. Your Operate As key goes in Authorization; the client's access is added for you.

See Pass-through requests for the full request and response format.

Call any endpoint

curl "https://api.operate.as/v1/clients/6f1c2a7e-.../app-store-server/inApps/v1/transactions/0" \
  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

curl "https://api.operate.as/v1/clients/6f1c2a7e-.../app-store-server/inApps/v1/transactions/0" \  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

Response

{
  "status": 200,
  "data": {
    "…": "the service's own response"
  },
  "encoding": "json"
}

{  "status": 200,  "data": {    "…": "the service's own response"  },  "encoding": "json"}

When access ends

A key works until your client deletes it in App Store Server API. They can paste a new one on the same link at any time, and your workflows carry on without changes.

See Keeping access alive and Removing access.

Calls answer, once the key is deleted

{
  "status": 401,
  "data": {
    "…": "the service's own error"
  },
  "encoding": "json"
}

{  "status": 401,  "data": {    "…": "the service's own error"  },  "encoding": "json"}