Usage & Examples ​

Connecting to the API ​

SWAGPI will be accessible as a global

var api = SWAGAPI.getInstance({
  wrapper: wrapper,
  api_key: '5c6c3c056917a692f96f9651',
  theme: 'shockwave',
  debug: true
});

API Options ​

The client must use the startSession method to start using the api and wait for the promise to resolve or the SESSION_READY event before using any other api calls.

Using promise:

api.startSession()
  .then(function() {
    //do stuff
  });

Using event listener:

api.on('SESSION_READY', function() {
  //do stuff
});

Using the API ​

Session Methods ​

End Game Options ​

The endGame method accepts an options object which enables developers to submit custom metrics for a game session.

Example use cases:

Single level runner game (without win condition):

{ feet: 134 }

Puzzle with countdown timer:

{ success: true }

Monster shooter with multiple types, tracking which enemy killed the player:

{ werewolf: 4, gargoyle: 2, ghoul: 12, killedBy: "ghoul" }

Start and End Game Usage ​

The startGame and endGame methods are intended to be used at the start and end of a game session.

This will enable game developers to view game metrics like average session time and number of play sessions in the developer dashboard.

The API may display UI elements when these methods are invoked such as interstitial ads or site promotions. When the display of these UI elements has completed, the promise will resolve.

Example use case of startGame:

- Player uses a start button
- startGame() method is invoked and returns a promise
- when the promise is resolved, game play starts

Example use case of endGame:

- Player is defeated in a game
- endGame() method is invoked and returns a promise
- when the promise is resolved, game displays a retry button

Score Methods ​

Score Methods Options ​

postScore Options ​

The following options are available:

example:

api.postScore('level_1', 400, { confirmation: true });

getScores Options ​

The following options are available:

Example (scores this week on level1 for the current user):

return api.getScores({
  type: 'weekly',
  level_key: 'level1',
  current_user: true
})
  .then(function(scores) {
    //do stuff
  });

UI Methods ​

showDialog Options ​

example:

api.showDialog('scores', {
  title: 'Best Scores',
  level_key: 'level1',
  period: 'alltime',
  value_formatter: ''
});

The following options are available:

Achievement Methods ​

Data Store Methods ​

Miscellaneous Methods ​

Branding Methods ​

The method SWAGAPI.showBrandingAnimation can be used to display the branding animation before a game. Note this is a static method so it can be used independently of the API instance.

example:

SWAGAPI.showBrandingAnimation('game')
  .then(function() {
    //display the game
  });

example (using callback):

SWAGAPI.showBrandingAnimation('game', function() {
  //display the game
});

Leaderboard ​

{
  type: 'leaderboard',
  data: [
    { username: 'user1', points: 300},
    { username: 'user1', points: 300},
    ...
  ]
}

Lobby ​

{
    type: 'lobby',
    data: [
      { username: 'user1'},
      { username: 'user2'},
      ...
    ]
}

Default ​

{
    type: 'default'
}

API Events ​

Demo ​

There is a simple demo of the api at:

https://swagapi.shockwave.com/demo.html (view source)