-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
1 addition
and
61 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,63 +1,3 @@ | ||
| # amazon-advertising-api-sdk | ||
|
|
||
| > Amazon Advertising API TypeScript and Node.js Unofficial SDK | ||
| ## Alpha Release 🚨 | ||
|
|
||
| This is an alpha release and is not meant for public consumption. | ||
|
|
||
| ## Install | ||
|
|
||
| ``` | ||
| npm i -s amazon-advertising-api-sdk@next | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| Mandatory reading: [Amazon Advertising API docs](https://advertising.amazon.com/API/docs/en-us) | ||
|
|
||
| ### OAuth Client | ||
|
|
||
| Inherits from, and implements similar interface to `client-oauth2` package. | ||
|
|
||
| ```ts | ||
| import { OAuthClient } from 'amazon-advertising-api-sdk' | ||
|
|
||
| const client = new OAuthClient({ | ||
| clientId: '...', | ||
| clientSecret: '...', | ||
| redirectUri: '...', | ||
| }) | ||
|
|
||
| // get redirect URL to send the user to start OAuth flow | ||
| const uri = client.getUri() | ||
|
|
||
| // get token | ||
| const token = client.getToken() | ||
|
|
||
| // refresh existing token | ||
| const token = client.createToken('... access token ...', '... refresh token ...') | ||
| const res = await token.refresh() | ||
| ``` | ||
|
|
||
| ### API Operations | ||
|
|
||
| The library is split into "operations", which are closely mapped to the operations (sections) of the | ||
| API. | ||
|
|
||
| ```ts | ||
| import { HttpClient, OperationProvider, ProfileOperation } from 'amazon-advertising-api-sdk' | ||
|
|
||
| // HTTP Client, tailored for the Amazon Advertising API | ||
| // See other endpoints: https://advertising.amazon.com/API/docs/en-us/get-started/how-to-use-api | ||
| const httpClient = new HttpClient('https://advertising-api.amazon.com', auth) | ||
|
|
||
| // A provider instance, that knows how to instantiate operation classes | ||
| const operationProvider = new OperationProvider(httpClient) | ||
|
|
||
| // Instantiate an "operation" object | ||
| const profileOperation = operationProvider.create(ProfileOperation) | ||
|
|
||
| // Using the operation object to make API calls | ||
| const res = await profileOperation.listProfiles() | ||
| ``` | ||
| This package is deprecated in favor of [@scaleleap/amazon-advertising-api-sdk](https://npm.im/@scaleleap/amazon-advertising-api-sdk) |