amzn / ads-advanced-tools-docs

Code samples and supplements for the Amazon Ads advanced tools center
https://advertising.amazon.com/API/docs/en-us/index
MIT No Attribution
96 stars 32 forks source link

[Doc] Missing parameter in the OAuth flow documentation #82

Closed IgniteMosquito closed 1 year ago

IgniteMosquito commented 1 year ago

We are now building the OAuth flow to easily connect new Amazon Ads accounts to our platform. We've noticed a small inconsistency in the documentation, hence I would like to clarify it.

We can pass a "state" parameter in the URL, which will be later returned to the redirect page (so we can capture the flow from the start to the end with it). We managed to build our authorization flow to use this parameter. And it works very well (similar to Selling Partner API). I want to confirm that this parameter will be supported. The older documentation version had this information, but I see it now disappeared (and I can't find any versioning to send you the example).

The URL parameters from the doc linked to this GitHub: https://advertising.amazon.com/API/docs/en-us/getting-started/create-authorization-grant The above document doesn't mention the "state" parameter.

jerirose commented 1 year ago

Hi @IgniteMosquito , yes the state parameter is supported by Login with Amazon. Our "Getting started" walkthrough demonstrates the most basic call flow for the API, but state is recommended for application integrations. Thank you for your feedback -- we have added a note on that page with a link to more information about optional parameters.

The state parameter is mentioned in our conceptual documentation on authorization grants, but the most complete information on LwA parameters can be found in the LwA documentation, including guidance on how to use state to guard against cross-site request forgery.