App Store Connect API client for Node.js
npm install appstore-connect-sdkThe appstore-connect-sdk is a Node.js module written in TypeScript that provides a convenient way for developers to interact with the App Store Connect API. The module is built using @hey-api/openapi-ts and provides support for all APIs based on the OpenAPI specification.
English | 简体中文
- Automate your workflow with the App Store Connect API
- App Store Connect API Official Documentation
- WWDC 2018 303 - Automating App Store Connect (Video)
The appstore-connect-sdk module includes the following features:
- [x] JWT Authentication - Configure with your API Key and let the SDK handle JWT token signing
- [x] Smart Token Management - Tokens are automatically generated, cached, and refreshed before expiration (within 2 minutes of expiry)
- [x] Full API Coverage - Support for all App Store Connect API endpoints through OpenAPI-generated code
- [x] Cross-Platform - Compatible with both Node.js and Deno environments
``bash`
npm install appstore-connect-sdk
#### 1. Import appstore-connect-sdk
`typescript`
import { createClient, appsGetCollection } from "appstore-connect-sdk";
#### 2. Create a client
Go to App Store Connect -> Users and Access -> Keys and create your own key. This is also the page to find your private key ID and the issuer ID.
The SDK supports both Team API Keys and Individual API Keys:
- Team API Keys: Used by teams, requires issuerId
- Individual API Keys: Used by individual developers, is not required
After downloading your private key, open the .p8 file containing the private key in a text editor. It should look like this:
`
-----BEGIN PRIVATE KEY-----
AIGTAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBHkwdwIBAQQgKEn1VBakCdHIEcdS
aBWr/9laASzaAbF2LP7wTYjHK52gCgYIKoZIzj0DAQehRANCAAQ/jf2sxRvXEhjn
srw8kJcHvO0dQ1KmUlxZvATsFsjJbdQ1yAENAWItUoeTV0rhdajcdOQxKl1OPse0
nNdXXbA4
-----END PRIVATE KEY-----
For Team API Keys:
`typescript`
const client = createClient({
issuerId: "
privateKeyId: "
privateKey: "
});
For Individual API Keys:
`typescript`
const client = createClient({
// No issuerId required for Individual API Keys
privateKeyId: "
privateKey: "
});
For more information on how JWT works with the App Store Connect API, check out Apple's authentication guides:
- Creating API Keys for App Store Connect API
- Generating Tokens for API Requests
- Revoking API Keys
Configuration Options:
| Option | Type | Required | Description |
|--------|------|----------|-------------|
| issuerId | string | For Team keys | Your issuer ID from App Store Connect |privateKeyId
| | string | Yes* | The ID of your private key |privateKey
| | string | Yes* | The private key content in PEM format |bearerToken
| | string | No | Provide your own JWT token instead of having the SDK generate one |expirationDuration
| | number | No | Token expiration in seconds (default: 1200 = 20 minutes, max: 20 minutes) |baseUrl
| | string | No | Override the API base URL (default: https://api.appstoreconnect.apple.com) |
*Required unless bearerToken is provided.
#### 3. Make API calls
All API functions are exported from the SDK. Pass the client to each API call.
`typescript`
const res = await appsGetCollection({ client });
console.log(res.data);
Here's the complete code example:
For Team API Keys:
`typescript
import { createClient, appsGetCollection } from "appstore-connect-sdk";
const client = createClient({
issuerId: "
privateKeyId: "
privateKey: "
});
const res = await appsGetCollection({ client });
console.log(res.data);
`
For Individual API Keys:
`typescript
import { createClient, appsGetCollection } from "appstore-connect-sdk";
const client = createClient({
// No issuerId for Individual API Keys
privateKeyId: "
privateKey: "
});
const res = await appsGetCollection({ client });
console.log(res.data);
`
All API functions follow the naming convention from the OpenAPI spec. Some common examples:
`typescript
import {
createClient,
appsGetCollection,
appsGetInstance,
buildsGetCollection,
betaTestersGetCollection,
} from "appstore-connect-sdk";
const client = createClient({ / your config / });
// Get all apps
const apps = await appsGetCollection({ client });
// Get a specific app
const app = await appsGetInstance({ client, path: { id: "app-id" } });
// Get builds for an app
const builds = await buildsGetCollection({ client, query: { "filter[app]": "app-id" } });
`
For advanced use cases, you can use the client directly for custom requests:
`typescript
import { createClient } from "appstore-connect-sdk";
const client = createClient({ / your config / });
// Use the client directly for custom requests
const response = await client.get({ url: "/v1/apps" });
`
For integration testing purposes, you can override the base URL of the App Store Connect API by setting the baseUrl option. For example, you can use this to point to a local mock server.
`typescript
import { createClient } from "appstore-connect-sdk";
const client = createClient({
// ...
baseUrl: "http://localhost:3000", // All network requests are made to http://localhost:3000
});
`
To update the OpenAPI-generated code, run the following command:
`bash`
$ sh gen-openapi.sh
This will generate TypeScript code through @hey-api/openapi-ts based on the OpenAPI specification file (app_store_connect_api_4.2_openapi.json) officially released by Apple.
The appstore-connect-sdk module is fully compatible with Deno. An example of using the appstore-connect-sdk module in a Deno environment can be found in the deno_example.
We are committed to ensuring that the appstore-connect-sdk` module remains fully compatible with both Node.js and Deno, and we will continue to work on improving its compatibility with Deno as the Deno runtime evolves.
appstore-connect-sdk is available under the MIT license, and uses source code from open source projects. See the LICENSE file for more information.
This project was originally created by isaced but has had many great contributors. We're open to contributions of any kind to make this project even better.