App Store Connect | Operate As Docs

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

Website: developer.apple.com/app-store-connect
Connects by: Pasting a Private key
Category: Developer tools
Services: 1
Tools: 251

Service	Key	Base URL
App Store Connect	`app-store-connect`	`https://api.appstoreconnect.apple.com`

Your client also types their issuer id (Above the list of keys in Users and Access, Integrations) and key id (Beside the key in Users and Access, Integrations).

Connecting

Your client makes a Private key in their App Store Connect settings and pastes it on their link. Operate As tries it with App Store Connect 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-connect"
    ]
  }
]

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

Permissions

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

Tools

Install App Store Connect's typed package for your language:

pip install operate-as-app-store-connect

pip install operate-as-app-store-connect

Run app-store-connect.age_rating_declarations_update_instance

curl -X POST https://api.operate.as/v1/actions/app-store-connect.age_rating_declarations_update_instance \
  -H "Authorization: Bearer $OPERATE_AS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "clientId": "6f1c2a7e-...",
    "input": {
      "id": "<id>"
    }
  }'

curl -X POST https://api.operate.as/v1/actions/app-store-connect.age_rating_declarations_update_instance \  -H "Authorization: Bearer $OPERATE_AS_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "clientId": "6f1c2a7e-...",    "input": {      "id": "<id>"    }  }'

Shows the required inputs. Every input, with its JSON Schema: GET /v1/actions/app-store-connect.age_rating_declarations_update_instance

Response

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

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

Pass-through

Paths continue from https://api.appstoreconnect.apple.com. 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-connect/v1/apps?limit=1" \
  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

curl "https://api.operate.as/v1/clients/6f1c2a7e-.../app-store-connect/v1/apps?limit=1" \  -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 Connect. 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"}