API Docs for: 0.0.1
Show:

Connect Class

Defined in: index.js:76
Module: itunesconnect

Initialize a new Connect with the given username, password and options.

Examples:

// Import itc-report
var itc     = require("itunesconnect"),
    Report  = itc.Report;

// Init new iTunes Connect
var itunes = new itc.Connect('apple@id.com', 'password');

// Init new iTunes Connect
var itunes = new itc.Connect('apple@id.com', 'password', {
    errorCallback: function(error) {
        console.log(error);
    },
    concurrentRequests: 1
});

Constructor

Connect

(
  • username
  • password
  • [options]
)

Defined in index.js:76

Parameters:

  • username String

    Apple ID login

  • password String

    Apple ID password

  • [options] Object optional
    • [baseURL] String optional

      iTunes Connect Login URL

    • [apiURL] String optional

      iTunes Connect API URL

    • [concurrentRequests] Number optional

      Number of concurrent requests

    • [cookies] Array optional

      Cookies array. If you provide cookies array it will not login and use this instead.

    • [errorCallback] Function optional

      Error callback function called when requests are failing

      • [error] Function optional
        Login error
    • [loginCallback] Function optional

      Login callback function called when login to iTunes Connect was a success.

      • [cookies] Function optional
        cookies are passed as a first argument. You can get it and cache it for later.

Item Index

Methods

Methods

executeRequest

(
  • task
  • callback
)
private

Defined in index.js:215

Execute iTunes Connect report request with given task and callback.

Parameters:

  • task Object
  • callback Function

login

(
  • username
  • password
)
private

Defined in index.js:258

Login to iTunes Connect with given username and password.

Parameters:

  • username String

    Apple ID login

  • password String

    Apple ID password

metadata

(
  • completed
)

Defined in index.js:181

Fetch iTunes Connect Reporting metadata with given completed callback.

Examples:

// Import itc-report
var itc     = require("itunesconnect"),
    Report  = itc.Report;

// Init new iTunes Connect
var itunes = new itc.Connect('apple@id.com', 'password');

// Fetch API Metadata
itunes.metadata(function(error, result) {
    console.log(result);
})

Parameters:

  • completed Function
    • error Error

      Just an error if occure

    • result Object

      Metadata result

    • [query] Object optional

      Query that was sent

request

(
  • query
  • completed
)
chainable

Defined in index.js:144

Request iTunes Connect report with the given query and completed callback.

Examples:

// Import itc-report
var itc     = require("itunesconnect"),
    Report  = itc.Report;

// Init new iTunes Connect
var itunes = new itc.Connect('apple@id.com', 'password');

// Request timed report from yesterday to today
itunes.request(Report.timed().time(1, 'day'), function(error, result) {
    console.log(result);
})

Parameters:

  • query Query
  • completed Function
    • error Error

      Just an error if occure

    • result Object

      Report result

    • [query] Object optional

      Query that was sent