{"__v":1,"_id":"57917efb180e233400f7101d","category":{"__v":0,"_id":"575709000fd6a3200010dded","project":"56abbf55f25f160d00e17f4e","version":"56abbf55f25f160d00e17f51","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-06-07T17:48:48.065Z","from_sync":false,"order":0,"slug":"test","title":"Platform Overview"},"parentDoc":null,"project":"56abbf55f25f160d00e17f4e","user":"56bcdc8ae0b1580d00b5d149","version":{"__v":12,"_id":"56abbf55f25f160d00e17f51","project":"56abbf55f25f160d00e17f4e","createdAt":"2016-01-29T19:36:53.665Z","releaseDate":"2016-01-29T19:36:53.665Z","categories":["56abbf56f25f160d00e17f52","56abca6bf9757e0d007c6650","56acddfa0ab3c00d00ce3332","56af65da9d32e30d0006d30f","56af66cab34d210d003d9ad0","56af6afcd21e9c0d00b628d1","56af6d6ecc4cbd0d00ce2c88","5705b12221cfed0e00e8c580","570a5676ade45d0e00c1ad33","570d7d25d1e4b82000d9e385","570eac3c3160d10e0041df0e","575709000fd6a3200010dded"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-07-22T02:03:39.116Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"Integrating your virtual goods game into Kongregate is a straightforward process that can be done in a few days by an experienced engineer.  \n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"There are some special permissions that have to be set for payment-enabled games and we screen these games to maintain a quality experience. Please email [apps:::at:::kongregate.com](mailto:apps@kongregate.com) ***before*** going through the integration process to request permission to publish the game if you are using our virtual goods API.\",\n  \"title\": \"Payment-Enabled Game Approval\"\n}\n[/block]\n### Connect to our Client API Object\n\nIn order to get access to some required basic user information for the server APIs, you'll need to connect to our local API through either ActionScript or Javascript.  You can find out details about the specific language connections in our [API Overview](doc:client-api-introduction) page.  Throughout the rest of the documentation you will see references to methods for this Kongregate API object.\n\n### Integrate a Few Quick APIs\n\nThere are three primary APIs that our games make use of.\n\n<div style=\"padding: 0 20px\">**Statistics:** This is a very simple API that allows you to submit progress and high scores of players in the game.  In addition to on-site leaderboards, this will enable us to put achievements on your game and feature it heavily if it gets a high-enough rating on the site.\n\n**Virtual Goods:** If your game supports in-app purchases, this API is required. It will enable you to accept Kongregate’s currency, kreds, as payment within your game.  Any non-kreds payment methods will need to be removed.  \n\n**Authentication:** If your game uses server-side game accounts, this is a required API (*we do not allow external login/registration systems*). Giving users a single-sign-on experience reduces registration friction, increasing the number of accounts in the game.  We have a simple API that allows you to validate a logged-in Kongregate user via a server-side call and get them into your game entirely behind the scenes.</div>","excerpt":"","slug":"integration-overview","type":"basic","title":"Integration Overview"}

Integration Overview


Integrating your virtual goods game into Kongregate is a straightforward process that can be done in a few days by an experienced engineer. [block:callout] { "type": "info", "body": "There are some special permissions that have to be set for payment-enabled games and we screen these games to maintain a quality experience. Please email [apps@kongregate.com](mailto:apps@kongregate.com) ***before*** going through the integration process to request permission to publish the game if you are using our virtual goods API.", "title": "Payment-Enabled Game Approval" } [/block] ### Connect to our Client API Object In order to get access to some required basic user information for the server APIs, you'll need to connect to our local API through either ActionScript or Javascript. You can find out details about the specific language connections in our [API Overview](doc:client-api-introduction) page. Throughout the rest of the documentation you will see references to methods for this Kongregate API object. ### Integrate a Few Quick APIs There are three primary APIs that our games make use of. <div style="padding: 0 20px">**Statistics:** This is a very simple API that allows you to submit progress and high scores of players in the game. In addition to on-site leaderboards, this will enable us to put achievements on your game and feature it heavily if it gets a high-enough rating on the site. **Virtual Goods:** If your game supports in-app purchases, this API is required. It will enable you to accept Kongregate’s currency, kreds, as payment within your game. Any non-kreds payment methods will need to be removed. **Authentication:** If your game uses server-side game accounts, this is a required API (*we do not allow external login/registration systems*). Giving users a single-sign-on experience reduces registration friction, increasing the number of accounts in the game. We have a simple API that allows you to validate a logged-in Kongregate user via a server-side call and get them into your game entirely behind the scenes.</div>