What you need to know before you start
Here is what you need to know when you are starting to integrate your game with Spil portals and systems.
We will provide you a game page on our integration portal that will have an iframe. The iframe will point to your game. You can use this environment in order to start integrating your game into our portals.
Furthermore we will provide you access to our payment tool where you can set the packages and manage the price of your virtual currency. To do that we will need some information from your side:
- A game URL publicly accessible, so our server can reach it.
- Desirable width and height of the iframe.
- An e-mail address that will receive automated payment failure notifications. Since this address may receive many notifications, it’s advisable to provide us a dedicated one.
- The e-mails of the people that will handle your company’s payment account in our payments back-end. Use the e-mail as username and in order to set up your password click on the button “I forgot my password” and follow the instructions.
In case you haven’t provided the above information to anyone at Spil Games, please send them to IntegrationSupport@spilgames.com. If you want to we can arrange a phone/Skype call in order to kick-off the integration.
The API currently offers the following features:
– Log in the users to your game and retrieve user data
– offer in-game purchases through the Spil Games Payment Service
– retrieve the user’s friends (so users can be exposed to each other in-game and they can start interacting)
– allow the user to send their portal friends an invitation via email to come play the game
– dynamically adjust the height of the game
– integrate game breaks (to be used with in-game ads for example)
What’s not currently available through our API is posting on a friends wall or sending a gift to a friend.
Starting the Integration
We will provide you a game page containing an iframe which points to your game. On the iframe URL we pass the following parameters. Your game can read these parameters.
|siteid||Integer – Holds the site ID value (ex.: 88)|
|channelid||Integer – Holds the channel ID value (ex.: 1). This information is relevant to us, please ignore it.|
|appToken||String – Among others holds
• Application ID which is a unique game id,
• GUID which is a unique User ID,
• Site id,
• Channel id.
By decoding the App token you can validate the username that is passed in the iframe url. Please keep in mind that is not mandatory to validate the appToken from your side.
For further details about the appToken see below.
|UID||String – This parameter is here for backwards compatibility reasons and is deprecated. Please ignore it.|
|username||String – Holds the user’s username (ex.: john_smith). If no username is passed you are dealing with a guest user.|
|siteLocale||String – Holds the Locale of the site (ex.: en-US)|
Follow the links below to start integrating our Game API and get access to our portals and user base:
- include the API in your game
- fetch User information
- fetch friends information
- adjust the height of your game
- integrate game breaks (it depends the type of deal you have with us)
Do we have to allow guest Users?
It’s totally up to you if you want to allow guest users or only register users are able to play your game. In case you choose the latter you should create a landing screen for the guest users. In this screen you explain that they need to register in order to play and place a button that triggers our login pop up. You will find more information on how to implemented here.
Do you have a unique identifier for your users?
Yes, it’s the value called GUID on our system. It’s unnique for a user, same on all of our portals. You can retrieve it in two way.
- From the getUser call.
- From validating the appToken.
What’s the appToken and what shall I do with it?
The appToken is an extra security layer, a way to validate that the user data. From our side it is NOT mandatory to validate the appToken, it’s totally up to you. More information about the appToken you can find here.
In case you do want to validate the appToken please request the secret from our side. Note that it can take up to 5 days to get back the secret from us.
What’s Spil policy in regards to game localization?
We prefer to release games that are localized on the portal language.
How can I serve the same language as the portal?
From the game iframe URL we are passing the parameter “siteLocale”. The best way is to get the locale from there and serve the proper language to the user.
How can I test the language selection implementation?
You can use the language toolbar as the picture below. By clicking to a language it will reload the game passing the locale that you selected.
To use the Spil Games Payment service, follow the links below:
- Front-end integration of payment API (include this in your game)
- Back-end integration of payment API (configure your back-end to accept our payments)
- Payment tool (enabling and configuring payments in your game)