Limited Error information in breeze api

[sans-sense]

in case of api errors like on 14th December, 2024 11:10 a.m when "'https://api.icicidirect.com/breezeapi/api/v1/customerdetails'" was down, the error message reported by

breeze.generate_session(api_secret=<some_secret>,session_token=<some_token>)

is "Invalid JSON format in API response". It may be better to add more error information from the actual response.

Suggested Fix

Declare response as None above try block and use the reponse.text if response is not None in composing the error message in method

Breeze-Python-SDK/breeze_connect/breeze_connect.py

Line 785 in 3bc6068

def api_util(self):

Details

Actual error reported by the url https://api.icicidirect.com/breezeapi/api/v1/customerdetails

'\n\n\n<title>Error</title>\n<style>\nhtml { color-scheme: light dark; }\nbody { width: 35em; margin: 0 auto;\nfont-family: Tahoma, Verdana, Arial, sans-serif; }\n</style>\n\n\n

An error occurred.

\n

Sorry, the page you are looking for is currently unavailable.
\nPlease try again later.

\n

If you are the system administrator of this resource then you should check\nthe error log for details.

\n

Faithfully yours, nginx.

\n\n\n'

Additionally the error message is leaking implementation details (like use of nginx) which may be a flag for security team

[Idirect-Tech]

Dear Apurba, Could you please check now? If you still encounter any issues, kindly let us know. [E29CF836] Thanks & Regards, Hiten Solanki, Team Breeze API, ICICI Securities

…

________________________________ From: Apurba Nath ***@***.***> Sent: Saturday, December 14, 2024 11:17 AM To: Idirect-Tech/Breeze-Python-SDK ***@***.***> Cc: Subscribed ***@***.***> Subject: [Idirect-Tech/Breeze-Python-SDK] Limited Error information in breeze api (Issue #170) CAUTION: This email originated from outside the organization! Do not click links, open attachments or reply, unless you recognize the sender's email address! Use 'Report suspicious Email' button in the toolbar to report Phishing mails. Beware! in case of api errors like on 14th December, 2024 11:10 a.m when "'https://api.icicidirect.com/breezeapi/api/v1/customerdetails'" was down, the error message reported by breeze.generate_session(api_secret=<some_secret>,session_token=<some_token>) is "Invalid JSON format in API response". It may be better to add more error information from the actual response. Suggested Fix Declare response as None above try block and use the reponse.text if response is not None in composing the error message in method https://github.com/Idirect-Tech/Breeze-Python-SDK/blob/3bc6068b74edbbec8757cb8e91ccb26c0a44ff92/breeze_connect/breeze_connect.py#L785 Details Actual error reported by the url https://api.icicidirect.com/breezeapi/api/v1/customerdetails '\n\n\n<title>Error</title>\n<style>\nhtml { color-scheme: light dark; }\nbody { width: 35em; margin: 0 auto;\nfont-family: Tahoma, Verdana, Arial, sans-serif; }\n</style>\n\n\n An error occurred. \n Sorry, the page you are looking for is currently unavailable. \nPlease try again later. \n If you are the system administrator of this resource then you should check\nthe error log for details. \n Faithfully yours, nginx. \n\n\n' Additionally the error message is leaking implementation details (like use of nginx) which may be a flag for security team — Reply to this email directly, view it on GitHub<#170>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/A3TQZ42IWQLSPMGXTG2HYF32FPBA3AVCNFSM6AAAAABTTG3PWCVHI2DSMVQWIX3LMV43ASLTON2WKOZSG4ZTSNJZGAZTENI>. You are receiving this because you are subscribed to this thread.Message ID: ***@***.***> Print this mail only if absolutely necessary. Save Paper. Save Trees." "The information contained in this e-mail and any attachments to this message are intended for the exclusive use of the intended recipient and may contain proprietary, confidential or legally privileged information. If you are not the intended recipient, please note that you are not authorised to disseminate, distribute or copy this e-mail or any parts of it or act upon/rely on the contents of this e-mail in any manner. Please notify the sender immediately by e-mail and destroy all copies of this e-mail and any attachments. Please also note that ICICI Bank or its subsidiaries and associated companies, (collectively "ICICI Group"), are unable to exercise control or ensure the integrity of/over the contents of the information contained in e-mail transmissions and that any views expressed in this e-mail are not endorsed by/binding on the ICICI Group unless the sender does so expressly with due authority of ICICI Group. Before opening any attachments please check them for viruses and defects and please note that ICICI Group accepts no liability or responsibility for any damage caused by any virus that may be transmitted by this email. Any unauthorized use of this email or any attachment(s) may be treated as infringement of right(s) including right of privacy under the applicable laws of India including Information and Technology Act, 2000. Thank you for your cooperation. Regulatory Disclosures are available on https://www.icicisecurities.com (for institutional business) and www.icicidirect.com (for retail business).

[sans-sense]

This issue is about error reporting rather than service disruption. While the API services were restored on Monday (16th dec '24), the error reporting is still the same which may need correcting. If otherwise, please feel free to close the issue.