https://github.com/egodigital/node-appstore-connect

API client for Apple App Store Connect API.
https://github.com/egodigital/node-appstore-connect

api apple appstore downloads library module npm reporting rest-api sales

Last synced: about 1 month ago
JSON representation

API client for Apple App Store Connect API.

• Host: GitHub
• URL: https://github.com/egodigital/node-appstore-connect
• Owner: egodigital
• License: lgpl-3.0
• Archived: true
• Created: 2019-11-26T17:02:25.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2021-01-15T01:59:19.000Z (almost 4 years ago)
• Last Synced: 2024-11-04T23:49:48.671Z (about 2 months ago)
• Topics: api, apple, appstore, downloads, library, module, npm, reporting, rest-api, sales
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@egodigital/appstore-connect
• Size: 115 KB
• Stars: 30
• Watchers: 3
• Forks: 11
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![npm](https://img.shields.io/npm/v/@egodigital/appstore-connect.svg)](https://www.npmjs.com/package/@egodigital/appstore-connect)

# @egodigital/appstore-connect

A simplfied library for [Node.js 10+](https://nodejs.org/docs/latest-v10.x/api/) for accessing [Apple's App Store Connect API](https://developer.apple.com/documentation/appstoreconnectapi), written in [TypeScript](https://www.typescriptlang.org/).

The module is quite new, so [issues](https://github.com/egodigital/node-appstore-connect/issues) and [pull requests](https://github.com/egodigital/node-appstore-connect/pulls) are very welcome :-)

## Install

Execute the following command from your project folder, where your `package.json` file is stored:

```bash

npm install --save @egodigital/appstore-connect

```

## Usage

```typescript

import * as fs from 'fs';

import { Client as AppStoreConnectClient, DownloadSalesReportFrequency } from '@egodigital/appstore-connect';

const PRIVATE_KEY = fs.readFileSync(

    '/path/to/your/p8/file'  // downloaded from https://appstoreconnect.apple.com/access/api

);

const CLIENT = new AppStoreConnectClient({

    apiKey: '',  // s. https://appstoreconnect.apple.com/access/api

    issuerId: '',  // s. https://appstoreconnect.apple.com/access/api

    privateKey: PRIVATE_KEY,

});

const SUMMARY = await CLIENT.getAppDownloads({

    frequency: DownloadSalesReportFrequency.Weekly,

    vendorId: '',  // s. https://appstoreconnect.apple.com/itc/payments_and_financial_reports

});

console.log(

    SUMMARY

);

```

## Documentation

The API documentation can be found [here](https://egodigital.github.io/appstore-connect/).