Connection to the App Store Connect API using Python3

App-Store-Connect-API-Python.md

How to connect to the App Store Connect API using Python3

You will need the requests and authlib packages. Just run :

$ pip install requests authlib

Then you need to generate an API Key from the App Store Connect portal (https://developer.apple.com/documentation/appstoreconnectapi/creating_api_keys_for_app_store_connect_api).

In the Python code below, replace the values of KEY_ID, ISSUER_ID and PATH_TO_KEY with your own.

You can change the URL of the request you want to make with the URL variable.

Finally, if you have some query parameters to pass in, use the params parameter of requests.get() (or requests.post()).

appstoreconnect-api.py

import requests, time, json
from authlib.jose import jwt

KEY_ID = "XXXXXXXXXX"
ISSUER_ID = "XXXXXX-XXXXXXX-XXXXXX-XXXXXXX"
EXPIRATION_TIME = int(round(time.time() + (20.0 * 60.0))) # 20 minutes timestamp
PATH_TO_KEY = 'path/to/your/key.p8'
with open(PATH_TO_KEY, 'r') as f:
    PRIVATE_KEY = f.read()

header = {
    "alg": "ES256",
    "kid": KEY_ID,
    "typ": "JWT"
}

payload = {
    "iss": ISSUER_ID,
    "exp": EXPIRATION_TIME,
    "aud": "appstoreconnect-v1"
}

# Create the JWT
token = jwt.encode(header, payload, PRIVATE_KEY)

# API Request
JWT = 'Bearer ' + token.decode()
URL = 'https://api.appstoreconnect.apple.com/v1/users'
HEAD = {'Authorization': JWT}

r = requests.get(URL, params={'limit': 200}, headers=HEAD)

# Write the response in a pretty printed JSON file
with open('output.json', 'w') as out:
    out.write(json.dumps(r.json(), indent=4))

Thank you 👍

just what I was looking for - thank you 👋

Thank you :)

It is returning 401 error code

this seems better than reporter thxs!

Thank you so much 🤗

thank you!!

Amazing thank you

Hi. I used this example early and it had worked fine, but today I faced with "Error 401". When I tried to use the same token in the curl, it has worked too. The solution is to change the expiration time to 19 min (thanks to my colleague Oleh for this solution)
EXPIRATION_TIME = int(round(time.time() + (19.0 * 60.0))) # 19 minutes timestamp

or just add small delay
time.sleep(5)
before request.

Hi, I set exp time 19 min, but I response 401 Error.
time.sleep(5) didn't help me.
If you know how to solve this problem, it will be nice..

If you have the same problem 401 ->
check your jwt encode in https://jwt.io, just paste in form Encoded your token after jwt.encode. You must see correct headers and payload. It helps me to find error.

Thank you very much for the sample code, I rewrote this sample with Applaud:

import os
from applaud.connection import Connection

KEY_ID = "XXXXXXXXXX"
ISSUER_ID = "XXXXXX-XXXXXXX-XXXXXX-XXXXXXX"
PATH_TO_KEY = os.path.expanduser('path/to/your/key.p8')

with open(PATH_TO_KEY, 'r') as f:
    PRIVATE_KEY = f.read()

# Create the Connection
connection = Connection(ISSUER_ID, KEY_ID, PRIVATE_KEY)
# API Request
r = connection.users().limit(10).get()

# Print user names
for user in r.data:
    print(user.attributes.username, user.attributes.first_name, user.attributes.last_name)

Applaud handles the details of JWT, you don't have to worry about expiration time. You can find the fork here: How to connect to the App Store Connect API using Python3 and Applaud

Thank you. I was getting 401 NOT_AUTHORIZED, changing expiration to 10 minutes fixed it.

Where to find "path_to_key" ?
Anyone please reply fast is possible!!!

Thankyou in Advanced

@tanuj2207 You can get it from app store key section.

getting this error
JWT = 'Bearer ' + token.decode()
AttributeError: 'str' object has no attribute 'decode'

anyone ran into this error in the past ?

Thank you! Apple also seems to require "bid" (bundle id) param for JWT payload now - at least it kept giving me 401 until I added it. Here's how their current payload example looks like:

{
  "iss": "57246542-96fe-1a63e053-0824d011072a",
  "iat": 1623085200,
  "exp": 1623086400,
  "aud": "appstoreconnect-v1",
  "bid": "com.example.testbundleid2021"
}

Hi @alex-childish,

where did you get "bid"?

@divyanshustaq

In app settings: https://support.appsflyer.com/hc/en-us/articles/360013555718-Finding-the-Apple-bundle-ID

I believe you can also get it via API:
https://developer.apple.com/documentation/appstoreconnectapi/list_bundle_ids