Authentication and Kreds Integartion

This document is meant to give a brief overview of how to integrate the Kongregate authentication and or Kreds/Microtransaction APIs into your Flash game. If you will be integrating the Authentication API, these instructions assume that you are running your own server/back-end that your client connects to.

Upload your game

You should upload your game to Kongregate, but keep it in the preview state. Next, email ben@kongregate.com to let me know so that I can give you some Kreds as well as granting your game special permissions since some of these APIs are not public yet. Note that only games which have been selected to participate in the microtransaction test phase will get a response, as these features are still in closed beta.

In this email, make sure to let me know your account name along with the game you want permissions granted on, along with any other accounts you would like Kreds donated to for testing.

You should leave your game in the preview state until it is fully tested.

Web Services/Authentication API

If you have a separate game server that needs to query our back-end for authentication or item information, then you should read the documentation for the Web Services API. Specifically, take a look at the authentication web service.

This covers obtaining your API key, Actionscript integration, the authentication API, and the Kreds/microtransaction API.

Microtransaction Client API

If you will be implementing the Microtransactions/Kreds API, you should read over the documentation which will cover how to set up your item store, along with how to query item information from your game. You can also consult the microtransaction web service documentation.

Handling Guests

Since guest users on Kongregate are not allowed to purchase or spend Kreds, your game will need to handle guests in a special fashion. For example, if a user wants to purchase items in your store, you will need to tell them to sign in or create a Kongregate account.

If you are implementing the authentication API, it is typically a good idea to try to upsell the user on the benefits of signing into Kongregate, including letting them know that they wont have to create an account for your game if they do so.

You can find documentation on how to handle guests in your games (including information on how to view your own game as a guest while it is in the preview state for testing) here.

IFrame integration

If your game is hosted on a non-Kongregate domain via an iframe, you will need to perform some additional work before things will function properly. An overview of the process can be found here

…

Kongregate