iFrames for registration and login

If you would like to integrate the registration- or login-process as used by Bigpoint in your own sites, you can use iFrames to integrate them.

The iFrames show automatically generated HTML pages and will handle all validation of usernames, e-mail-adresses and more. The forms are hosted on Bigpoint's servers and will communicate closely with the account systems in place. All you need to do is to make sure that the Game-API is implemented correctly in your game.

With each registration, not only an account in your game is created - the user will receive a portal account as well and can use this account to play other games integrated using the Devlounge.

Basis-URLs für iFrames

To generate valid URLs for both iFrames, different base-URLs are used:

All necessary parameters are appended to these base-URLs as GET parameters.

Required parameters

To generate valid iFrame-URLs, the following parameters need to be appended to the base-URLs as described above.

Name of parameter Type Description
partnerID Integer This is the partner-ID assigned to your account when you registered at the DevLounge.
projectID Integer This is the project-ID assigned to your current project. Note that this ID will change for each new instance of your game and after it has been put into live.
lang String The language in which the iFrame should appear. You can use a short form here (e.g. 'de' or 'en') or the longer standardized locale format (only for 'en_US' or 'pt_BR').
cssurl (Optional) String A URL pointing towards a CSS file on your servers. This file can be used to customize the look and feel of the iFrame and make it blend in with the rest of your site.
aid (Optional) Integer This parameter contains the affiliateID - if your site has been requested with an aid, please make sure to transmit its value here as well.
aip (Optional) String This parameter contains the affiliate parameters- if your site has been requested with an aip, please make sure to transmit its value here as well.
aig (Optional) Integer This parameter contains the affiliate group information - if your site has been requested with an aig, please make sure to transmit its value here as well.
acm (Optional) Integer This parameter contains the affiliate cross marketing information - if your site has been requested with an acm, please make sure to transmit its value here as well.
acr (Optional) Integer This parameter contains the affiliate cross reference - if your site has been requested with an acr, please make sure to transmit its value here as well.
affiliateHost (Optional) String If your game can be accessed using a special domain for a specified partner, please make sure to send this information back to the API using this parameter (e.g. mtv.mygame.com).
authTimestamp Double A unix-timestamp containing the current number of milliseconds since the begin of the UNIX epoch (1/1/1970).
hash String A hash used for authentication and generated using a number of parameters used in this request (see below).
userID Integer A numerical representation of an user in your game. This ID is assigned during the registration-process in your game (this is the userID of the existing account!).

Creating the Hash

To create the hash as used in the iFrame URL, you need to generate a hash using the MD5-algorithm and a specified array of parameters put after one another in a string:

  • partnerID
  • projectID
  • lang
  • cssurl
  • aid
  • authTimestamp
  • Secret-Key

It is important to notice, that the “cssurl” parameter needs to be urlencoded and if you haven't received an “aid” parameter, you are supposed to use a “0”.

Here is an example using 23 as the partnerID and 45 as the projectID:

2345enhttp%3a%2f%2fwww.yourdomain.com%2fcss%2fiframe.css01281623154.432291f5d0cdf0b6f20f0a15884d2b6733

The resulting MD5-hash looks like this: 977c2a98779f9ae8367b500794b8be94.

en/apis/iframes.txt · Last modified: 2012/08/31 10:08 (external edit)
www.chimeric.de Valid CSS Driven by DokuWiki do yourself a favour and use a real browser - get firefox!! Recent changes RSS feed Valid XHTML 1.0