ASConnectService provides a type-safe, Swift-native interface to Apple's App Store Connect API. This package enables developers to programmatically interact with App Store Connect services for managing apps, builds, reviews, sales reports, and more.

The library is automatically generated from the official App Store Connect API OpenAPI specification using Apple's swift-openapi-generator, ensuring complete API coverage and type safety.

Installation

Add ASConnectService as a dependency in your Package.swift file:

dependencies: [
    .package(url: "https://github.com/rock-n-code/asconnect-service.git", from: "1.0.0")
]

Then add it to your target dependencies:

.target(
    name: "YourTarget",
    dependencies: [
        "ASConnectService"
    ]
)

Usage

Creating a Client

Create a Client instance by providing a server URL and transport. Use BearerAuthMiddleware to authenticate requests with a JSON Web Token (JWT).

The App Store Connect API requires authentication using API keys. You'll need to:

Create an API key in App Store Connect
Generate a signed JWT token using your key ID, issuer ID, and private key
Pass the token to the built-in BearerAuthMiddleware when creating the client

import ASConnectService
import OpenAPIURLSession

let client = Client(
    serverURL: try Servers.Server1.url(),
    transport: URLSessionTransport(),
    middlewares: [
        BearerAuthMiddleware(token: yourJWTToken)
    ]
)

Tokens expire after 20 minutes at most. For longer-lived clients, pass a token provider instead, which is called on every request:

BearerAuthMiddleware {
    try await tokenStore.validToken()
}

Making API Calls

Each endpoint is a method on Client, declared by APIProtocol. It returns an Output enum with a case for each documented response:

let response = try await client.appsGetCollection(query: .init(limit: 10))
let apps = try response.ok.body.json.data

The ok property throws for any other response. To handle those, switch over the Output cases, such as .unauthorized or .undocumented(statusCode:_:).

Supported Platforms

iOS 13.0+
macOS 10.15+
tvOS 13.0+
visionOS 1.0+
watchOS 6.0+

Development

Building

make lib-build

Testing

make lib-test

Generating Documentation

# Generate documentation archive (for Xcode)
make doc-generate-archive

# Generate documentation for static hosting (e.g. GitHub Pages)
make doc-generate-github

# Preview documentation locally in Safari
make doc-preview

README.md

App Store Connect Service (ASConnectService)

Overview