The Golang server library for the App Store Server API and App Store Server Notifications.
The App Store Server API is a REST API that you call from your server to request and provide information about your customers' in-app purchases.
The App Store Server API is independent of the app’s installation status on the customers’ devices. The App Store server returns information based on a customer’s in-app purchase history regardless of whether the customer installs, removes, or reinstalls the app on their devices.
go get github.com/richzw/appstoreLog in to App Store Connect and complete the following steps:
- Select Users and Access, and then select the Keys tab.
- Select In-App Purchase under the Key Type.
- Click Generate API Key or the Add (+) button.
- Enter a name for the key. The name is for your reference only and isn’t part of the key itself. Click Generate.
- Click Download API Key next to the new API key. And store your private key in a secure place.
import(
"github.com/richzw/appstore"
)
// ACCOUNTPRIVATEKEY is the key file generated from previous step
const ACCOUNTPRIVATEKEY = `
-----BEGIN PRIVATE KEY-----
FAKEACCOUNTKEYBASE64FORMAT
-----END PRIVATE KEY-----
`
func main() {
c := &appstore.StoreConfig{
KeyContent: []byte(ACCOUNTPRIVATEKEY),
KeyID: "FAKEKEYID",
BundleID: "fake.bundle.id",
Issuer: "xxxxx-xx-xx-xx-xxxxxxxxxx",
Sandbox: false,
}
transactionId := "FAKETRANSACTIONID"
a := appstore.NewStoreClient(c)
response, err := a.GetTransactionInfo(context.TODO(), transactionId)
transantions, err := a.ParseSignedTransactions([]{response.SignedTransactionInfo})
if transactions[0].TransactionId == transactionId {
// the transaction is valid
}
}- Validate the receipt
- One option could be to validate the receipt with the App Store server through
GetTransactionInfoAPI, and then check thetransactionIdin the response matches the one you are looking for.
- One option could be to validate the receipt with the App Store server through
- The App Store Server API differentiates between a sandbox and a production environment based on the base URL:
- Use https://api.storekit.itunes.apple.com/ for the production environment.
- Use https://api.storekit-sandbox.itunes.apple.com/ for the sandbox environment.
- If you're unsure about the environment, follow these steps:
- Initiate a call to the endpoint using the production URL. If the call is successful, the transaction identifier is associated with the production environment.
- If you encounter an error code
4040010, indicating aTransactionIdNotFoundError, make a call to the endpoint using the sandbox URL.
- Handle exceeded rate limits gracefully
- If you exceed a per-hour limit, the API rejects the request with an HTTP 429 response, with a RateLimitExceededError in the body. Consider the following as you integrate the API:
- If you periodically call the API, throttle your requests to avoid exceeding the per-hour limit for an endpoint.
- Manage the HTTP 429 RateLimitExceededError in your error-handling process. For example, log the failure and queue the job to process it again at a later time.
- Check the Retry-After header if you receive the HTTP 429 error. This header contains a UNIX time, in milliseconds, that informs you when you can next send a request.
- If you exceed a per-hour limit, the API rejects the request with an HTTP 429 response, with a RateLimitExceededError in the body. Consider the following as you integrate the API:
- Error handling
- handler error per apple store server api error document
- error definition
import(
"github.com/richzw/appstore"
)
// ACCOUNTPRIVATEKEY is the key file generated from previous step
const ACCOUNTPRIVATEKEY = `
-----BEGIN PRIVATE KEY-----
FAKEACCOUNTKEYBASE64FORMAT
-----END PRIVATE KEY-----
`
func main() {
c := &appstore.StoreConfig{
KeyContent: []byte(ACCOUNTPRIVATEKEY),
KeyID: "FAKEKEYID",
BundleID: "fake.bundle.id",
Issuer: "xxxxx-xx-xx-xx-xxxxxxxxxx",
Sandbox: false,
}
invoiceOrderId := "FAKEORDERID"
a := appstore.NewStoreClient(c)
rsp, err := a.LookupOrderID(context.TODO(), invoiceOrderId)
orders, err := a.ParseSignedTransactions(rsp.SignedTransactions)
}import(
"github.com/richzw/appstore"
)
// ACCOUNTPRIVATEKEY is the key file generated from previous step
const ACCOUNTPRIVATEKEY = `
-----BEGIN PRIVATE KEY-----
FAKEACCOUNTKEYBASE64FORMAT
-----END PRIVATE KEY-----
`
func main() {
c := &appstore.StoreConfig{
KeyContent: []byte(ACCOUNTPRIVATEKEY),
KeyID: "FAKEKEYID",
BundleID: "fake.bundle.id",
Issuer: "xxxxx-xx-xx-xx-xxxxxxxxxx",
Sandbox: false,
}
originalTransactionId := "FAKEORDERID"
a := appstore.NewStoreClient(c)
query := &url.Values{}
query.Set("productType", "AUTO_RENEWABLE")
query.Set("productType", "NON_CONSUMABLE")
gotRsp, err := a.GetTransactionHistory(context.TODO(), originalTransactionId, query)
for _, rsp := range gotRsp {
trans, err := a.ParseSignedTransactions(rsp.SignedTransactions)
}
}import(
"github.com/richzw/appstore"
)
// ACCOUNTPRIVATEKEY is the key file generated from previous step
const ACCOUNTPRIVATEKEY = `
-----BEGIN PRIVATE KEY-----
FAKEACCOUNTKEYBASE64FORMAT
-----END PRIVATE KEY-----
`
func main() {
c := &appstore.StoreConfig{
KeyContent: []byte(ACCOUNTPRIVATEKEY),
KeyID: "FAKEKEYID",
BundleID: "fake.bundle.id",
Issuer: "xxxxx-xx-xx-xx-xxxxxxxxxx",
Sandbox: false,
}
originalTransactionId := "FAKEORDERID"
a := appstore.NewStoreClient(c)
gotRsp, err := a.GetRefundHistory(context.TODO(), originalTransactionId)
for _, rsp := range gotRsp {
trans, err := a.ParseSignedTransactions(rsp.SignedTransactions)
}
}import (
"github.com/richzw/appstore"
"github.com/golang-jwt/jwt/v4"
)
func main() {
c := &appstore.StoreConfig{
KeyContent: []byte(ACCOUNTPRIVATEKEY),
KeyID: "FAKEKEYID",
BundleID: "fake.bundle.id",
Issuer: "xxxxx-xx-xx-xx-xxxxxxxxxx",
Sandbox: false,
}
tokenStr := "SignedRenewalInfo Encode String" // or SignedTransactionInfo string
a := appstore.NewStoreClient(c)
token, err := a.ParseNotificationV2(tokenStr)
claims, ok := token.Claims.(jwt.MapClaims)
for key, val := range claims {
fmt.Printf("Key: %v, value: %v\n", key, val) // key value of TransactionInfo
}
}import (
"github.com/richzw/appstore"
"github.com/golang-jwt/jwt/v4"
)
func main() {
c := &appstore.StoreConfig{
KeyContent: []byte(ACCOUNTPRIVATEKEY),
KeyID: "FAKEKEYID",
BundleID: "fake.bundle.id",
Issuer: "xxxxx-xx-xx-xx-xxxxxxxxxx",
Sandbox: false,
}
tokenStr := "JWSTransactionDecodedPayload Encode String"
a := appstore.NewStoreClient(c)
jws, err := a.ParseNotificationV2WithClaim(tokenStr)
// access the fields of JWSTransactionDecodedPayload from jws directly
}App Store Server API 1.11+
appstore is licensed under the MIT.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent