https://api.nexscope.ai/amazonAds/authorizeUrlRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/amazonAds/authorizeUrl |
| Auth | Bearer API key |
| Content-Type | application/json |
Amazon Ads operation guide
Use operation: authorize with region and marketplaceId to start OAuth, operation: connections to list connections owned by your API key, and operation: profiles with an owned connectionId to list profiles. Open the returned authorization URL in a browser.
Provider access and refresh tokens stay on the backend. This public API does not accept or return raw provider tokens.
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
region | string | required | Amazon Ads region. Example: NA |
marketplaceId | string | required | Amazon marketplace identifier for the Ads connection. Example: ATVPDKIKX0DER |
workspaceId | string | required | A Nexscope workspace accessible to the authenticated user. |
accountName | string | optional | Display name for the authorized account. |
Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
No response example is published for this API. Refer to the response fields below.
Response fields
Response field reference (2 fields)
| Name | Type | Required | Description |
|---|---|---|---|
authorizeUrl | string | optional | Amazon Ads OAuth authorization URL. |
sourceType | string | optional | Authorization source identifier, fixed to `amazon_ads`. |
Responses
| Code | Description |
|---|---|
| 200 | Default HTTP response for both success and many business errors. Only outer JSON code 0 indicates success or asynchronous acceptance; inspect data for the result. |
| 429 | Execution admission rate limit; honor Retry-After when present. |
| 503 | Execution admission is temporarily unavailable; honor Retry-After when present. |
| Opt-in | X-Nexscope-Http-Status: semantic maps controller-handled business errors to HTTP status on run and task routes. Pre-authentication failures, such as a missing API key (code 11209), may still return HTTP 200 before this mapping. Always check the outer JSON code; malformed requests and infrastructure failures may also return non-200 HTTP responses. |
Data source, freshness, and limitations
Source, freshness, coverage, rate limits, and estimation notes are not specified in this API definition unless they appear in the request or response field documentation above. Do not assume official marketplace data or real-time freshness when it is not explicitly documented.