ncxxcnmx v1.22.2

Getting started

Marvel Comics API SDK

How to Build

The generated SDK relies on Node Package Manager (NPM) being available to resolve dependencies. If you don't already have NPM installed, please go ahead and follow instructions to install NPM from here. The SDK also requires Node to be installed. If Node isn't already installed, please install it from here

NPM is installed by default when Node is installed

To check if node and npm have been successfully installed, write the following commands in command prompt:

• node --version
• npm -version

Now use npm to resolve all dependencies by running the following command in the root directory (of the SDK folder):

npm install

This will install all dependencies in the node_modules folder.

Once dependencies are resolved, you will need to move the folder MarvelComicsLib in to your node_modules folder.

How to Use

The following section explains how to use the library in a new project.

1. Open Project Folder

Open an IDE/Text Editor for JavaScript like Sublime Text. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.

Click on File and select Open Folder.

Select the folder of your SDK and click on Select Folder to open it up in Sublime Text. The folder will become visible in the bar on the left.

2. Creating a Test File

Now right click on the folder name and select the New File option to create a new test file. Save it as index.js Now import the generated NodeJS library using the following lines of code:

var lib = require('lib');

Save changes.

3. Running The Test File

To run the index.js file, open up the command prompt and navigate to the Path where the SDK folder resides. Type the following command to run the file:

node index.js

How to Test

These tests use Mocha framework for testing, coupled with Chai for assertions. These dependencies need to be installed for tests to run. Tests can be run in a number of ways:

Method 1 (Run all tests)

1. Navigate to the root directory of the SDK folder from command prompt.
2. Type mocha --recursive to run all the tests.

Method 2 (Run all tests)

1. Navigate to the ../test/Controllers/ directory from command prompt.
2. Type mocha * to run all the tests.

Method 3 (Run specific controller's tests)

1. Navigate to the ../test/Controllers/ directory from command prompt.
2. Type mocha MarvelComicsController to run all the tests in that controller file.

To increase mocha's default timeout, you can change the TEST_TIMEOUT parameter's value in TestBootstrap.js.

Initialization

Authentication

In order to setup authentication in the API client, you need the following information.

API client can be initialized as following:

const lib = require('lib');

// Configuration parameters and credentials
lib.Configuration.referer = "*.marvel.com";
lib.Configuration.apikey = "apikey";

Class Reference

List of Controllers

• CharactersController
• ComicsController
• EventsController
• SeriesController
• StoriesController
• CreatorsController

CharactersController

Get singleton instance

The singleton instance of the CharactersController class can be accessed from the API Client.

var controller = lib.CharactersController;

getCharacterCollection

Fetches lists of characters.

function getCharacterCollection(comics, events, limit, modifiedSince, name, nameStartsWith, offset, orderBy, series, stories, callback)

Parameters

Example Usage

    var comics = 'comics';
    var events = 'events';
    var limit = 'limit';
    var modifiedSince = 'modifiedSince';
    var name = 'name';
    var nameStartsWith = 'nameStartsWith';
    var offset = 'offset';
    var orderBy = 'orderBy';
    var series = 'series';
    var stories = 'stories';

    controller.getCharacterCollection(comics, events, limit, modifiedSince, name, nameStartsWith, offset, orderBy, series, stories, function(error, response, context) {

    
    });

Errors

getCharacterIndividual

Fetches a single character by id.

function getCharacterIndividual(characterId, callback)

Parameters

Example Usage

    var characterId = 'characterId';

    controller.getCharacterIndividual(characterId, function(error, response, context) {

    
    });

Errors

getComicCharacterCollection

Fetches lists of characters filtered by a comic id.

function getComicCharacterCollection(comicId, events, limit, modifiedSince, name, nameStartsWith, offset, orderBy, series, stories, callback)

Parameters

Example Usage

    var comicId = 'comicId';
    var events = 'events';
    var limit = 'limit';
    var modifiedSince = 'modifiedSince';
    var name = 'name';
    var nameStartsWith = 'nameStartsWith';
    var offset = 'offset';
    var orderBy = 'orderBy';
    var series = 'series';
    var stories = 'stories';

    controller.getComicCharacterCollection(comicId, events, limit, modifiedSince, name, nameStartsWith, offset, orderBy, series, stories, function(error, response, context) {

    
    });

Errors

getEventCharacterCollection

Fetches lists of characters filtered by an event id.

function getEventCharacterCollection(eventId, comics, limit, modifiedSince, name, nameStartsWith, offset, orderBy, series, stories, callback)

Parameters

Example Usage

    var eventId = 'eventId';
    var comics = 'comics';
    var limit = 'limit';
    var modifiedSince = 'modifiedSince';
    var name = 'name';
    var nameStartsWith = 'nameStartsWith';
    var offset = 'offset';
    var orderBy = 'orderBy';
    var series = 'series';
    var stories = 'stories';

    controller.getEventCharacterCollection(eventId, comics, limit, modifiedSince, name, nameStartsWith, offset, orderBy, series, stories, function(error, response, context) {

    
    });

Errors

getSeriesCharacterWrapper

Fetches lists of characters filtered by a series id.

function getSeriesCharacterWrapper(seriesId, comics, events, limit, modifiedSince, name, nameStartsWith, offset, orderBy, stories, callback)

Parameters

Example Usage

    var seriesId = 'seriesId';
    var comics = 'comics';
    var events = 'events';
    var limit = 'limit';
    var modifiedSince = 'modifiedSince';
    var name = 'name';
    var nameStartsWith = 'nameStartsWith';
    var offset = 'offset';
    var orderBy = 'orderBy';
    var stories = 'stories';

    controller.getSeriesCharacterWrapper(seriesId, comics, events, limit, modifiedSince, name, nameStartsWith, offset, orderBy, stories, function(error, response, context) {

    
    });

Errors

getCharacterCollectionByStoryId

Fetches lists of characters filtered by a story id.

function getCharacterCollectionByStoryId(storyId, comics, events, limit, modifiedSince, name, nameStartsWith, offset, orderBy, series, callback)

Parameters

Example Usage

    var storyId = 'storyId';
    var comics = 'comics';
    var events = 'events';
    var limit = 'limit';
    var modifiedSince = 'modifiedSince';
    var name = 'name';
    var nameStartsWith = 'nameStartsWith';
    var offset = 'offset';
    var orderBy = 'orderBy';
    var series = 'series';

    controller.getCharacterCollectionByStoryId(storyId, comics, events, limit, modifiedSince, name, nameStartsWith, offset, orderBy, series, function(error, response, context) {

    
    });

Errors

Back to List of Controllers

ComicsController

Get singleton instance

The singleton instance of the ComicsController class can be accessed from the API Client.

var controller = lib.ComicsController;

getComicsCharacterCollection

Fetches lists of comics filtered by a character id.

function getComicsCharacterCollection(characterId, collaborators, creators, dateDescriptor, dateRange, diamondCode, digitalId, ean, events, format, formatType, hasDigitalIssue, isbn, issn, issueNumber, limit, modifiedSince, noVariants, offset, orderBy, series, sharedAppearances, startYear, stories, title, titleStartsWith, upc, callback)

Parameters

Example Usage

    var characterId = 'characterId';
    var collaborators = 'collaborators';
    var creators = 'creators';
    var dateDescriptor = Object.keys(dateDescriptor)[0];
    var dateRange = 'dateRange';
    var diamondCode = 'diamondCode';
    var digitalId = 'digitalId';
    var ean = 'ean';
    var events = 'events';
    var format = 'format';
    var formatType = Object.keys(formatType)[0];
    var hasDigitalIssue = 'hasDigitalIssue';
    var isbn = 'isbn';
    var issn = 'issn';
    var issueNumber = 'issueNumber';
    var limit = 'limit';
    var modifiedSince = 'modifiedSince';
    var noVariants = 'noVariants';
    var offset = 'offset';
    var orderBy = 'orderBy';
    var series = 'series';
    var sharedAppearances = 'sharedAppearances';
    var startYear = 'startYear';
    var stories = 'stories';
    var title = 'title';
    var titleStartsWith = 'titleStartsWith';
    var upc = 'upc';

    controller.getComicsCharacterCollection(characterId, collaborators, creators, dateDescriptor, dateRange, diamondCode, digitalId, ean, events, format, formatType, hasDigitalIssue, isbn, issn, issueNumber, limit, modifiedSince, noVariants, offset, orderBy, series, sharedAppearances, startYear, stories, title, titleStartsWith, upc, function(error, response, context) {

    
    });

Errors

getComicsCollection

Fetches lists of comics.

function getComicsCollection(characters, collaborators, creators, dateDescriptor, dateRange, diamondCode, digitalId, ean, events, format, formatType, hasDigitalIssue, isbn, issn, issueNumber, limit, modifiedSince, noVariants, offset, orderBy, series, sharedAppearances, startYear, stories, title, titleStartsWith, upc, callback)

Parameters

Example Usage

    var characters = 'characters';
    var collaborators = 'collaborators';
    var creators = 'creators';
    var dateDescriptor = Object.keys(dateDescriptor)[0];
    var dateRange = 'dateRange';
    var diamondCode = 'diamondCode';
    var digitalId = 'digitalId';
    var ean = 'ean';
    var events = 'events';
    var format = 'format';
    var formatType = Object.keys(formatType)[0];
    var hasDigitalIssue = 'hasDigitalIssue';
    var isbn = 'isbn';
    var issn = 'issn';
    var issueNumber = 'issueNumber';
    var limit = 'limit';
    var modifiedSince = 'modifiedSince';
    var noVariants = 'noVariants';
    var offset = 'offset';
    var orderBy = 'orderBy';
    var series = 'series';
    var sharedAppearances = 'sharedAppearances';
    var startYear = 'startYear';
    var stories = 'stories';
    var title = 'title';
    var titleStartsWith = 'titleStartsWith';
    var upc = 'upc';

    controller.getComicsCollection(characters, collaborators, creators, dateDescriptor, dateRange, diamondCode, digitalId, ean, events, format, formatType, hasDigitalIssue, isbn, issn, issueNumber, limit, modifiedSince, noVariants, offset, orderBy, series, sharedAppearances, startYear, stories, title, titleStartsWith, upc, function(error, response, context) {

    
    });

Errors

getComicIndividual

Fetches a single comic by id.

function getComicIndividual(comicId, callback)

Parameters

Example Usage

    var comicId = 'comicId';

    controller.getComicIndividual(comicId, function(error, response, context) {

    
    });

Errors

getComicsCollectionByCreatorId

Fetches lists of comics filtered by a creator id.

function getComicsCollectionByCreatorId(creatorId, characters, collaborators, dateDescriptor, dateRange, diamondCode, digitalId, ean, events, format, formatType, hasDigitalIssue, isbn, issn, issueNumber, limit, modifiedSince, noVariants, offset, orderBy, series, sharedAppearances, startYear, stories, title, titleStartsWith, upc, callback)

Parameters

Example Usage

    var creatorId = 'creatorId';
    var characters = 'characters';
    var collaborators = 'collaborators';
    var dateDescriptor = Object.keys(dateDescriptor)[0];
    var dateRange = 'dateRange';
    var diamondCode = 'diamondCode';
    var digitalId = 'digitalId';
    var ean = 'ean';
    var events = 'events';
    var format = 'format';
    var formatType = Object.keys(formatType)[0];
    var hasDigitalIssue = 'hasDigitalIssue';
    var isbn = 'isbn';
    var issn = 'issn';
    var issueNumber = 'issueNumber';
    var limit = 'limit';
    var modifiedSince = 'modifiedSince';
    var noVariants = 'noVariants';
    var offset = 'offset';
    var orderBy = 'orderBy';
    var series = 'series';
    var sharedAppearances = 'sharedAppearances';
    var startYear = 'startYear';
    var stories = 'stories';
    var title = 'title';
    var titleStartsWith = 'titleStartsWith';
    var upc = 'upc';

    controller.getComicsCollectionByCreatorId(creatorId, characters, collaborators, dateDescriptor, dateRange, diamondCode, digitalId, ean, events, format, formatType, hasDigitalIssue, isbn, issn, issueNumber, limit, modifiedSince, noVariants, offset, orderBy, series, sharedAppearances, startYear, stories, title, titleStartsWith, upc, function(error, response, context) {

    
    });

Errors

getComicsCollectionByEventId

Fetches lists of comics filtered by an event id.

function getComicsCollectionByEventId(eventId, characters, collaborators, creators, dateDescriptor, dateRange, diamondCode, digitalId, ean, events, format, formatType, hasDigitalIssue, isbn, issn, issueNumber, limit, modifiedSince, noVariants, offset, orderBy, series, sharedAppearances, startYear, stories, title, titleStartsWith, upc, callback)

Parameters

Example Usage

    var eventId = 'eventId';
    var characters = 'characters';
    var collaborators = 'collaborators';
    var creators = 'creators';
    var dateDescriptor = Object.keys(dateDescriptor)[0];
    var dateRange = 'dateRange';
    var diamondCode = 'diamondCode';
    var digitalId = 'digitalId';
    var ean = 'ean';
    var events = 'events';
    var format = 'format';
    var formatType = Object.keys(formatType)[0];
    var hasDigitalIssue = 'hasDigitalIssue';
    var isbn = 'isbn';
    var issn = 'issn';
    var issueNumber = 'issueNumber';
    var limit = 'limit';
    var modifiedSince = 'modifiedSince';
    var noVariants = 'noVariants';
    var offset = 'offset';
    var orderBy = 'orderBy';
    var series = 'series';
    var sharedAppearances = 'sharedAppearances';
    var startYear = 'startYear';
    var stories = 'stories';
    var title = 'title';
    var titleStartsWith = 'titleStartsWith';
    var upc = 'upc';

    controller.getComicsCollectionByEventId(eventId, characters, collaborators, creators, dateDescriptor, dateRange, diamondCode, digitalId, ean, events, format, formatType, hasDigitalIssue, isbn, issn, issueNumber, limit, modifiedSince, noVariants, offset, orderBy, series, sharedAppearances, startYear, stories, title, titleStartsWith, upc, function(error, response, context) {

    
    });

Errors

getComicsCollectionBySeriesId

Fetches lists of comics filtered by a series id.

function getComicsCollectionBySeriesId(seriesId, characters, collaborators, creators, dateDescriptor, dateRange, diamondCode, digitalId, ean, events, format, formatType, hasDigitalIssue, isbn, issn, issueNumber, limit, modifiedSince, noVariants, offset, orderBy, sharedAppearances, startYear, stories, title, titleStartsWith, upc, callback)

Parameters

Example Usage

    var seriesId = 'seriesId';
    var characters = 'characters';
    var collaborators = 'collaborators';
    var creators = 'creators';
    var dateDescriptor = Object.keys(dateDescriptor)[0];
    var dateRange = 'dateRange';
    var diamondCode = 'diamondCode';
    var digitalId = 'digitalId';
    var ean = 'ean';
    var events = 'events';
    var format = 'format';
    var formatType = Object.keys(formatType)[0];
    var hasDigitalIssue = 'hasDigitalIssue';
    var isbn = 'isbn';
    var issn = 'issn';
    var issueNumber = 'issueNumber';
    var limit = 'limit';
    var modifiedSince = 'modifiedSince';
    var noVariants = 'noVariants';
    var offset = 'offset';
    var orderBy = 'orderBy';
    var sharedAppearances = 'sharedAppearances';
    var startYear = 'startYear';
    var stories = 'stories';
    var title = 'title';
    var titleStartsWith = 'titleStartsWith';
    var upc = 'upc';

    controller.getComicsCollectionBySeriesId(seriesId, characters, collaborators, creators, dateDescriptor, dateRange, diamondCode, digitalId, ean, events, format, formatType, hasDigitalIssue, isbn, issn, issueNumber, limit, modifiedSince, noVariants, offset, orderBy, sharedAppearances, startYear, stories, title, titleStartsWith, upc, function(error, response, context) {

    
    });

Errors

getComicsCollectionByStoryId

Fetches lists of comics filtered by a story id.

function getComicsCollectionByStoryId(storyId, characters, collaborators, creators, dateDescriptor, dateRange, diamondCode, digitalId, ean, events, format, formatType, hasDigitalIssue, isbn, issn, issueNumber, limit, modifiedSince, noVariants, offset, orderBy, series, sharedAppearances, startYear, title, titleStartsWith, upc, callback)

Parameters

Example Usage

    var storyId = 'storyId';
    var characters = 'characters';
    var collaborators = 'collaborators';
    var creators = 'creators';
    var dateDescriptor = Object.keys(dateDescriptor)[0];
    var dateRange = 'dateRange';
    var diamondCode = 'diamondCode';
    var digitalId = 'digitalId';
    var ean = 'ean';
    var events = 'events';
    var format = 'format';
    var formatType = Object.keys(formatType)[0];
    var hasDigitalIssue = 'hasDigitalIssue';
    var isbn = 'isbn';
    var issn = 'issn';
    var issueNumber = 'issueNumber';
    var limit = 'limit';
    var modifiedSince = 'modifiedSince';
    var noVariants = 'noVariants';
    var offset = 'offset';
    var orderBy = 'orderBy';
    var series = 'series';
    var sharedAppearances = 'sharedAppearances';
    var startYear = 'startYear';
    var title = 'title';
    var titleStartsWith = 'titleStartsWith';
    var upc = 'upc';

    controller.getComicsCollectionByStoryId(storyId, characters, collaborators, creators, dateDescriptor, dateRange, diamondCode, digitalId, ean, events, format, formatType, hasDigitalIssue, isbn, issn, issueNumber, limit, modifiedSince, noVariants, offset, orderBy, series, sharedAppearances, startYear, title, titleStartsWith, upc, function(error, response, context) {

    
    });

Errors

Back to List of Controllers

EventsController

Get singleton instance

The singleton instance of the EventsController class can be accessed from the API Client.

var controller = lib.EventsController;

getCharacterEventsCollection

Fetches lists of events filtered by a character id.

function getCharacterEventsCollection(characterId, comics, creators, limit, modifiedSince, name, nameStartsWith, offset, orderBy, series, stories, callback)

Parameters

Example Usage

    var characterId = 'characterId';
    var comics = 'comics';
    var creators = 'creators';
    var limit = 'limit';
    var modifiedSince = 'modifiedSince';
    var name = 'name';
    var nameStartsWith = 'nameStartsWith';
    var offset = 'offset';
    var orderBy = 'orderBy';
    var series = 'series';
    var stories = 'stories';

    controller.getCharacterEventsCollection(characterId, comics, creators, limit, modifiedSince, name, nameStartsWith, offset, orderBy, series, stories, function(error, response, context) {

    
    });

Errors

getIssueEventsCollection

Fetches lists of events filtered by a comic id.

function getIssueEventsCollection(comicId, characters, creators, limit, modifiedSince, name, nameStartsWith, offset, orderBy, series, stories, callback)

Parameters

Example Usage

    var comicId = 'comicId';
    var characters = 'characters';
    var creators = 'creators';
    var limit = 'limit';
    var modifiedSince = 'modifiedSince';
    var name = 'name';
    var nameStartsWith = 'nameStartsWith';
    var offset = 'offset';
    var orderBy = 'orderBy';
    var series = 'series';
    var stories = 'stories';

    controller.getIssueEventsCollection(comicId, characters, creators, limit, modifiedSince, name, nameStartsWith, offset, orderBy, series, stories, function(error, response, context) {

    
    });

Errors

getCreatorEventsCollection

Fetches lists of events filtered by a creator id.

function getCreatorEventsCollection(creatorId, characters, comics, limit, modifiedSince, name, nameStartsWith, offset, orderBy, series, stories, callback)

Parameters

Example Usage

    var creatorId = 'creatorId';
    var characters = 'characters';
    var comics = 'comics';
    var limit = 'limit';
    var modifiedSince = 'modifiedSince';
    var name = 'name';
    var nameStartsWith = 'nameStartsWith';
    var offset = 'offset';
    var orderBy = 'orderBy';
    var series = 'series';
    var stories = 'stories';

    controller.getCreatorEventsCollection(creatorId, characters, comics, limit, modifiedSince, name, nameStartsWith, offset, orderBy, series, stories, function(error, response, context) {

    
    });

Errors

getEventsCollection

Fetches lists of events.

function getEventsCollection(characters, comics, creators, limit, modifiedSince, name, nameStartsWith, offset, orderBy, series, stories, callback)

Parameters

Example Usage

    var characters = 'characters';
    var comics = 'comics';
    var creators = 'creators';
    var limit = 'limit';
    var modifiedSince = 'modifiedSince';
    var name = 'name';
    var nameStartsWith = 'nameStartsWith';
    var offset = 'offset';
    var orderBy = 'orderBy';
    var series = 'series';
    var stories = 'stories';

    controller.getEventsCollection(characters, comics, creators, limit, modifiedSince, name, nameStartsWith, offset, orderBy, series, stories, function(error, response, context) {

    
    });

Errors

getEventIndividual

Fetches a single event by id.

function getEventIndividual(eventId, callback)

Parameters

Example Usage

    var eventId = 'eventId';

    controller.getEventIndividual(eventId, function(error, response, context) {

    
    });

Errors

getEventsCollectionBySeriesId

Fetches lists of events filtered by a series id.

function getEventsCollectionBySeriesId(seriesId, characters, comics, creators, limit, modifiedSince, name, nameStartsWith, offset, orderBy, stories, callback)

Parameters