apple-reporter

apple-reporter

Promise-based Apple iTunes Connect Reporter for Node.js > 4.2.0.

Results are automagically ungzipped. In Robot.XML mode (which is default), the XML is parsed into an object using xml2js. Errors result in a Promise rejection with best effort to set the code and message properties. Setting the code is not possible for text mode. (code defaults to -1)

Installation

npm i -S apple-reporter

yarn add apple-reporter

Example

Initialization

You can initialize an AppleReporter with an access token or the account password.

const AppleReporter = require('apple-reporter');

const reporter = new AppleReporter({
    userid: 'your-itunesocnnect-userid',
    accesstoken: 'your-itunesconnect-access-token',
});

// OR:
const reporter = new AppleReporter({
    userid: 'your-itunesocnnect-userid',
    password: 'your-itunesconnect-account-password',
});

If you supply a password, note that an access token is still required to fetch data. However, supplying a password allows you to call reporter.retrieveAccessToken() to automatically retrieve and set the access token for the account:

const AppleReporter = require('apple-reporter');

const reporter = new AppleReporter({
    userid: 'your-itunesocnnect-userid',
    password: 'your-itunesconnect-account-password',
});

reporter.retrieveAccessToken(options) // See below
.then(() => {
    // Other methods will now work (see 'Usage' section)
})

retrieveAccessToken() takes an options object, which defaults to the following:

reporter.retrieveAccessToken({
    // Normally, once this method is called and the access token
    // is set, subsequent calls to this method will just return
    // the access code retrieved earlier, instead of re-fetching
    forceRetrieve: false,
    // Set this to true to force re-fetching of the access token

    // Normally, if there is no access token or one is expired,
    // no new token will be generated without explicit permission
    generateNewIfNeeded: false,
    // Setting this to true grants that explicit permission
})
.then(...)

The most common way to use this method is with both of these options set: retrieveAccessToken({ forceRetrieve: true, generateNewIfNeeded: true}). This ensures that the access token will be refreshed on every call and, in case it expires, generated anew. Note in particular, that if you never set forceRetrieve, you will not know when your token is expired. This is left as an option in case you want to optimize your application by, say, managing the access token timeframe yourself and checking the token less frequently.

If you'll always use the same options, they can also be passed in the config at initialization:

const reporter = new AppleReporter({
    userid: 'your-itunesocnnect-userid',
    password: 'your-itunesconnect-account-password',
    tokenOptions: {
        forceRetrieve: true,
        generateNewIfNeeded: true
    }
});

These will be used if no options are passed to retrieveAccessToken(), but options passed to the method will always take precedence.

retrieveAccessToken() resolves to an object containing the token and a boolean indicating if it was newly generated or not:

reporter.retrieveAccessToken({ forceRetrieve: true, generateNewIfNeeded: true })
.then(({ token, isNew }) => {
    console.log(`Token: ${token}, was newly generated: ${isNew}`);

    // Other API methods will now work (see 'Usage' section)
})

If you supply an access token to begin with, you do not need to call this method before using the rest of the library. In the case that you only supply a password, the rest of the API will not work until this method has been called.

Usage

Example:

reporter.Finance.getStatus().then((status) => {
    return reporter.Finance.getReport({
        vendorNumber: 123456,
        regionCode: 'US',
        reportType: 'Financial',
        fiscalYear: '2015',
        fiscalPeriod: '02'
    })
    .then((report) => {
        // do stuff with report...
    })
    .catch((err) => {
        // uh-oh!
        console.error('Unable to get Finance report!');

        throw err;
    });
}, err => {
    console.error('Finance is down!');

    throw err;
});  

API

Refer to Apple's documentation for the specifications of each call. All Sales-based functions are under reporter.Sales, all Finance-based functions are under reporter.Finance

Constructor

• options (object)
  • baseUrl: Base endpoint for the API (defaults to https://reportingitc-reporter.apple.com/reportservice)
  • financeUrl: Finance endpoint URL (defaults to /finance/v1)
  • mode: Either Normal or Robot.XML (defaults to Robot.XML)
  • accesstoken: iTunes Connect access token
  • password: iTunes Connect account password
  • salesUrl: Sales endpoint URL (defaults to /sales/v1)
  • userid: iTunes Connect account user ID
  • version: The API version (defaults to 1.0)
  • tokenOptions: (object) The options object used in retrieveAccessToken(), if none is passed to the method
    • forceRetrieve: Actually make an API call to retrieve the token, even if one is already set (defaults to false)
    • generateNewIfNeeded: Generate a new token automatically if it is found to be expired or non-existent (defaults to false)

General

• getVersion

Sales

• getAccounts
• getReport
• getStatus
• getVendors
• getVersion

Finance

• getAccounts
• getReport
• getStatus
• getVendorsAndRegions
• getVersion