@amazon-sp-api-release/amazon-sp-api-sdk-js 1.0.0-rc1 → 1.0.0-rc2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +0 -95
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,98 +1,3 @@
|
|
|
1
|
-
## Java SDK for Selling Partner API
|
|
2
|
-
[](https://central.sonatype.com/artifact/software.amazon.spapi/spapi-sdk)
|
|
3
|
-
|
|
4
|
-
[](https://www.youtube.com/watch?v=OmYTAA80V_4)
|
|
5
|
-
|
|
6
|
-
*Click on the image to watch the video.*
|
|
7
|
-
|
|
8
|
-
The Selling Partner API SDK for Java enables you to easily connect your Java application to Amazon's REST-based Selling Partner API.
|
|
9
|
-
|
|
10
|
-
* [Learn more about Selling Partner API](https://developer.amazonservices.com/)
|
|
11
|
-
* [Selling Partner API Documentation](https://developer-docs.amazon.com/sp-api/)
|
|
12
|
-
* [JavaDoc](https://www.javadoc.io/doc/software.amazon.spapi/spapi-sdk/latest/index.html)
|
|
13
|
-
|
|
14
|
-
### Getting started
|
|
15
|
-
|
|
16
|
-
#### Credentials
|
|
17
|
-
|
|
18
|
-
Before you can use the SDK, you need to be registered as a Selling Partner API developer. If you haven't done that yet, please follow the instructions in the [SP-API Registration Overview](https://developer-docs.amazon.com/sp-api/docs/sp-api-registration-overview).
|
|
19
|
-
You also need to register your application to get valid credentials to call SP-API. If you haven't done that yet, please follow the instructions in [Registering your Application](https://developer-docs.amazon.com/sp-api/docs/registering-your-application).
|
|
20
|
-
If you are already registered successfully, you can find instructions on how to view your credentials in [Viewing your Application Information and Credentials](https://developer-docs.amazon.com/sp-api/docs/viewing-your-application-information-and-credentials).
|
|
21
|
-
|
|
22
|
-
#### Minimum requirements
|
|
23
|
-
|
|
24
|
-
To run the SDK you need Java 11 or higher.
|
|
25
|
-
|
|
26
|
-
#### Integrate the SDK
|
|
27
|
-
|
|
28
|
-
1. Find the latest version number [here](https://github.com/amzn/selling-partner-api-sdk/releases).
|
|
29
|
-
2. Add the dependency to your project (see instructions for [Gradle](#gradle) and [Maven](#maven) below).
|
|
30
|
-
|
|
31
|
-
##### Gradle
|
|
32
|
-
|
|
33
|
-
Add the following line to the dependencies in your `build.gradle` file:
|
|
34
|
-
|
|
35
|
-
```
|
|
36
|
-
implementation 'software.amazon.spapi:spapi-sdk:0.1.0'
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
##### Maven
|
|
40
|
-
|
|
41
|
-
Add the following lines to the dependencies in your `maven.pom` file:
|
|
42
|
-
|
|
43
|
-
```xml
|
|
44
|
-
<dependencies>
|
|
45
|
-
...
|
|
46
|
-
<dependency>
|
|
47
|
-
<groupId>software.amazon.spapi</groupId>
|
|
48
|
-
<artifactId>spapi-sdk</artifactId>
|
|
49
|
-
<version>0.1.0</version>
|
|
50
|
-
</dependency>
|
|
51
|
-
...
|
|
52
|
-
</dependencies>
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
### Use the SDK
|
|
56
|
-
|
|
57
|
-
In order to call one of the APIs included in the Selling Partner API, you need to:
|
|
58
|
-
1. Configure credentials (Note: Use your individual credentials for `clientId`, `clientSecret` and `refreshToken`)
|
|
59
|
-
2. Create an instance for a specific API
|
|
60
|
-
3. Call an operation
|
|
61
|
-
|
|
62
|
-
For an example, refer to the following sample code for connecting to Sellers API:
|
|
63
|
-
```java
|
|
64
|
-
// Configure your LWA credentials
|
|
65
|
-
LWAAuthorizationCredentials lwaAuthorizationCredentials = LWAAuthorizationCredentials.builder()
|
|
66
|
-
.clientId("amzn1.application-*********************")
|
|
67
|
-
.clientSecret("***********************************")
|
|
68
|
-
.refreshToken("Atzr|******************************")
|
|
69
|
-
.endpoint("https://api.amazon.com/auth/o2/token")
|
|
70
|
-
.build();
|
|
71
|
-
|
|
72
|
-
// Create an instance of the Sellers API
|
|
73
|
-
SellersApi sellersApi = new SellersApi.Builder()
|
|
74
|
-
.lwaAuthorizationCredentials(lwaAuthorizationCredentials)
|
|
75
|
-
.endpoint("https://sellingpartnerapi-na.amazon.com") // use Sandbox URL here if you would like to test your applications without affecting production data.
|
|
76
|
-
.build();
|
|
77
|
-
|
|
78
|
-
// Call operation
|
|
79
|
-
GetMarketplaceParticipationsResponse result = sellersApi.getMarketplaceParticipations();
|
|
80
|
-
```
|
|
81
|
-
|
|
82
|
-
### Additional documentation
|
|
83
|
-
|
|
84
|
-
You can find the JavaDoc for the latest SDK version [here](https://www.javadoc.io/doc/software.amazon.spapi/spapi-sdk/latest/index.html).
|
|
85
|
-
|
|
86
|
-
### Giving Feedback
|
|
87
|
-
|
|
88
|
-
We need your help in making this SDK great. Please participate in the community and contribute to this effort by submitting issues, participating in discussion forums and submitting pull requests through the following channels:
|
|
89
|
-
|
|
90
|
-
Submit [issues](https://github.com/amzn/selling-partner-api-sdk/issues/new/choose) - this is the preferred channel to interact with our team
|
|
91
|
-
Articulate your feature request or upvote existing ones on our [Issues][sdk-issues] page
|
|
92
|
-
|
|
93
|
-
[sdk-issues]: https://github.com/amzn/selling-partner-api-sdk/issues
|
|
94
|
-
|
|
95
|
-
|
|
96
1
|
|
|
97
2
|
|
|
98
3
|
|
package/package.json
CHANGED