Is there a way to read the error when the API fails?

[ammu2288]

Is there a way to read the error when the API fails?

I am using the APIs to get user info. But it randomly fails and throws the following error:
" appstoreconnect.api.APIError: An unexpected error occurred on the server side. If this issue continues, contact us at https://developer.apple.com/contact/."

So the API calls fail without any warning or returning any reason.

Adding how to print the error object when the API fails in the example would be helpful.

[ppawlak]

Hello,

I am sorry but the error message you mention is the exact error message sent by Apple. Please contact them at the provided link if you want more info on the error.

[ammu2288]

Hi @ppawlak ,

Attached is the screenshot of the details Apple needs to help me identify the issue.

They need the following details from the error.
• "X-Request-ID" value from the header of the response
• “ID” provided in the error response
• “Code” provided in the error response

Is there a way I can extract these details from the error I am getting back? Any example usage?

[ppawlak]

Hi @ammu2288

Thanks for pointing out those info which are returned by Apple API and should be exposed by this library. I have re-opened this issue and will complete the APIError exception class.

I'd been able to reproduce an error and extract the ID and Code from the error response but I can't see an X-Request-ID from the response headers.

Can you share an example of API usage that fails?

[ammu2288]

@ppawlak thanks for your response.

The APIs are run as a part of automated scripts and currently I don't have information as to which API is failing exactly to crash.
Could you please update with ID and Code so that we can retry and check?

[ammu2288]

FYI, Looks like whenever a fetchPage() call is made in api.py, either by __len__ / __next__, the exception is occurring. Looks like whenever I am trying to loop the users returned from list_users api or try to check the length of the users, this is happening.
Added screenshots for your reference

Screenshot 1:

Screenshot 2:

Screenshot 3:

[ppawlak]

@ammu2288

I've just made a change in branch here that let you retrieve the whole error details sent by Apple. For example, you can do:

	try:
		users = api.list_users()
		print(len(users))
	except APIError as e:
		print(e.errors)

If an error occurs on the Apple API this will print a dict with, among other things, an ID and a code.
Can you give it try?

By the way, I was not able to reproduce the error you mentioned bu accessing the length of the users. The code above works for me.

[ammu2288]

@ppawlak , thanks a lot for quick response. Will check it. Greatly Appreciated. :)

Related to the __len__ and __next__ issue, below is the code I am using.

print("Checking user for updating role..")
   users = self.appconnect_api.list_users(filters={'username': "sample@abc.com"})

   if not users:
       print("User not present to update..")
   else: 
       print("User present to update")

In the above code, I am calling the libraries list_users method and after it returns users, I am trying to check if it has more than 1 user or not using if not users:. Then internally __len__ gets called for IterResource and then the fetch_page() gets called which in turn fails.
Could you try to reproduce the same on your side? It might happen once in 5-10 times. Its not happening always.
Also, is there a better way to check if users is not empty which doesn't use the overridden __len__ or __next__ ?

[ammu2288]

@ppawlak , I was able to use your branch to get more info on the error.

Should I be importing as
from appstoreconnect import Api, UserRole, APIError ?

When I do this , I get the following error.
from appstoreconnect import Api, UserRole, APIError
ImportError: cannot import name 'APIError'

Any idea why?

This is how I am adding it the branch in requirements.in
git+https://github.com/Ponytech/appstoreconnectapi.git@api-errors-rework

[ammu2288]

Hi @ppawlak ,

FYI , I investigated to see that when creating the jwt payload, iat is missing and is not being sent, according to the apple docs.

https://developer.apple.com/documentation/appstoreconnectapi/generating_tokens_for_api_requests

This is resulting in a invalid token error (unauthorized error) as below. I added the iat locally and seems like the issue is fixed.

I updated this

return jwt.encode({'iss': self.issuer_id, 'exp': exp, 'aud': 'appstoreconnect-v1'}, key, headers={'kid': self.key_id, 'typ': 'JWT'}, algorithm=ALGORITHM).decode('ascii')

to

return jwt.encode({'iss': self.issuer_id, 'exp': exp, 'aud': 'appstoreconnect-v1', **'iat': gen_time**}, key, headers={'kid': self.key_id, 'typ': 'JWT'}, algorithm=ALGORITHM).decode('ascii')