Project

app_store_server_api

0.0
The project is in a healthy, maintained state
app_store_server_apimnyify/app_store_server_apiHomepageDocumentationSource CodeBug TrackerWiki
Manage your customers' App Store transactions from your server.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
214
Stars
0
Forks
0
Watchers
0
 Releases
Current version
0.1.0
Total releases
1
First release
2024-05-18
Latest release
2024-05-18
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2024-05-18
Reverse Dependencies
0

 Dependencies

Runtime

jwt
~> 2.8
 Project Readme

app-store-server-api

A Ruby client for the App Store Server API.

Features

  • Transaction history, subscription status
  • Notification test and history endpoints
  • Manages authentication tokens for you
  • Helpers to decode JWS items
  • Performs certificate validation against Apple's CA.

Requirements

Ruby 3.x

Installation

gem install app_store_server_api

Usage

Prerequisites

To get started, you must obtain the following:

Configure

In your Rails application, create a client configure

# my_app/config/app_store_server.yml
default: &default
  private_key: |
    -----BEGIN PRIVATE KEY-----
  key_id: S4AZ693A4A
  issuer_id: fd02853a-1290-4854-875e-918c86459b3e
  bundle_id: com.myapp.app
  environment: sandbox

development:
  <<: *default

test:
  <<: *default

production:
  <<: *default

Load the configure

# my_app/config/application.rb

config.app_store_server = config_for :app_store_server

Create a global client

# my_app/config/initializers/app_store_server_api.rb

AppStoreServerApiClient = AppStoreServerApi::Client.new(**Rails.configuration.app_store_server)

API

Get Transaction History

data = client.get_transaction_history(transaction_id,
  params: {
    sort: "DESCENDING"
  })

transactions = AppStoreServerApi::Utils::Decoder.decode_transactions signed_transactions: data["signedTransactions"]

Get Transaction Info

client.get_transaction_info transaction_id

Get All Subscription Statuses

response = client.get_all_subscription_statuses transaction_id

signed = response["data"].first["lastTransactions"].first["signedTransactionInfo"]

transaction = AppStoreServerApi::Utils::Decoder.decode_transaction signed_transaction: signed

Request a Test Notification

client.request_a_test_notification

Utils

  • AppStoreServerApi::Utils::Decoder.decode_transaction
  • AppStoreServerApi::Utils::Decoder.decode_jws!

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the AppStoreServerApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.