# Apilow GameCoin

> GameCoin is the bank of your game: it keeps the virtual currency, the inventory and the orders of web and mobile games. You call it from the browser (publishable key: reads, spends, pays; it can never credit), from your server (secret key: everything), or both. Payments are simulated in the test environment; real payments are not available yet.

The whole documentation in one file: https://gamecoin.apilow.com/llms-full.txt

## Getting started

- [Introduction](https://gamecoin.apilow.com/docs/index.md): What GameCoin is, how its pieces fit together, and which of the three ways to integrate it suits your game.
- [Quickstart](https://gamecoin.apilow.com/docs/quickstart.md): Sell your game's virtual currency and items in minutes with the browser SDK or the server API, in two paths of three steps each.
- [Core concepts](https://gamecoin.apilow.com/docs/concepts.md): The vocabulary of GameCoin on one page, from currencies and buckets to orders, keys and environments.

## Concepts

- [Wallets and ledger](https://gamecoin.apilow.com/docs/concepts/wallets-and-ledger.md): How balances are stored, which coins are spent first, what a refund does to a balance, and how to read the history of every change.
- [Players and tokens](https://gamecoin.apilow.com/docs/concepts/players-and-tokens.md): How a player is named, when GameCoin creates one for you, and how a browser proves which player it acts for.
- [Keys and environments](https://gamecoin.apilow.com/docs/concepts/keys-and-environments.md): The three credentials of GameCoin, where each one may live, and how the test and live environments are kept apart.
- [Idempotency](https://gamecoin.apilow.com/docs/concepts/idempotency.md): How to send the same write twice without it counting twice, which routes need a key, and how to choose one.
- [Security model](https://gamecoin.apilow.com/docs/concepts/security-model.md): Who can do what in GameCoin, why a browser can never add coins to a balance, and what the service refuses by design.
- [Errors](https://gamecoin.apilow.com/docs/concepts/errors.md): The shape of every error the API returns, the full table of codes, and how to handle the ones your game will meet.
- [Rate limits](https://gamecoin.apilow.com/docs/concepts/rate-limits.md): How many requests each key, player and address may send per period, what a 429 looks like, and how to stay under the limits.

## Guides

- [A game without a backend](https://gamecoin.apilow.com/docs/guides/no-backend-game.md): Build a browser game that sells a currency pack and an item with only the browser SDK and a publishable key, from first line to a working page.
- [Sign in players with their e-mail](https://gamecoin.apilow.com/docs/guides/player-email-sign-in.md): Let an anonymous player link an e-mail address with a six-digit code, and find the same player again on another device, without a password and without a backend.
- [A game with a backend](https://gamecoin.apilow.com/docs/guides/game-with-backend.md): Run GameCoin from your own server, reward players there, hand each browser a one-hour token, and use the browser SDK for the rest.
- [Selling packs](https://gamecoin.apilow.com/docs/guides/selling-packs.md): Sell a pack for euros with a checkout and the hosted payment page, from the VAT to the return URL and the life of an order.
- [Founder packs](https://gamecoin.apilow.com/docs/guides/founder-packs.md): Sell packs before your game launches, during a window and in limited quantity, and read the stock left from the catalog.
- [Gift codes and creator codes](https://gamecoin.apilow.com/docs/guides/codes.md): Hand out gift codes for free coins and items, and track the sales and the commission of your content creators with creator codes.
- [The hosted shop](https://gamecoin.apilow.com/docs/guides/hosted-shop.md): Open a ready-made shop page for your game, identify the player with a signed link or an e-mail code, and bring them back to your game after a purchase.
- [Refunds](https://gamecoin.apilow.com/docs/guides/refunds.md): Refund a paid order from your server, see what is taken back from the player, and read what a refund could not recover.
- [Webhooks](https://gamecoin.apilow.com/docs/guides/webhooks.md): Let GameCoin call your server when an order is delivered, refunded or disputed, and check the signature of every call.
- [Free currencies and items](https://gamecoin.apilow.com/docs/guides/free-currencies-and-items.md): Hand out currency and items from your server, let players buy and use items, and know the limits that apply.
- [Testing](https://gamecoin.apilow.com/docs/guides/testing.md): Try your whole integration without spending money, with the test environment, simulated payments, test players and the demo game.

## Browser SDK

- [Browser SDK](https://gamecoin.apilow.com/docs/sdk/browser.md): The complete reference of gamecoin.js, the one-file SDK that lets a browser game read, spend, buy, consume, sell packs, redeem gift codes and open the shop with a publishable key.
- [Shop widget](https://gamecoin.apilow.com/docs/sdk/widget.md): Put the GameCoin shop inside your web game with one script, in a modal or in a page element, and hear about the balance and the purchases from your code.

## Server SDKs

- [Server SDKs](https://gamecoin.apilow.com/docs/sdk/server.md): Pick the GameCoin SDK for your backend language (Node.js, Python, PHP, Go or C#) and learn what the five have in common and where they differ.
- [Node.js SDK](https://gamecoin.apilow.com/docs/sdk/node.md): Install the GameCoin SDK for Node.js and use it from your game backend to manage wallets, the ledger, inventory, checkouts and refunds.
- [Python SDK](https://gamecoin.apilow.com/docs/sdk/python.md): Install the GameCoin SDK for Python and use it from your game backend to manage wallets, the ledger, inventory, checkouts and refunds.
- [PHP SDK](https://gamecoin.apilow.com/docs/sdk/php.md): Install the GameCoin SDK for PHP and use it from your game backend to manage wallets, the ledger, inventory, checkouts and refunds.
- [Go SDK](https://gamecoin.apilow.com/docs/sdk/go.md): Install the GameCoin SDK for Go and use it from your game backend to manage wallets, the ledger, inventory, checkouts and refunds.
- [C# SDK](https://gamecoin.apilow.com/docs/sdk/dotnet.md): Install the GameCoin SDK for .NET and use it from your game backend to manage wallets, the ledger, inventory, checkouts and refunds.

## API reference

- [API reference](https://gamecoin.apilow.com/docs/api.md): The GameCoin API v1 in one place, with the rules every call shares and an example in six languages for each operation.
- [API objects](https://gamecoin.apilow.com/docs/api/objects.md): The shape of every object the GameCoin API returns, with its fields, its possible values and a real example.
- [Catalog API](https://gamecoin.apilow.com/docs/api/catalog.md): Read the active currencies, items and packs of your game from your backend with the server API.
- [Players API](https://gamecoin.apilow.com/docs/api/players.md): Create and update players, read them back, and issue the tokens your game client needs, with the server API.
- [Wallet API](https://gamecoin.apilow.com/docs/api/wallet.md): Read a player's balances, grant them free currency and spend it from your backend with the server API.
- [Ledger API](https://gamecoin.apilow.com/docs/api/ledger.md): Read the immutable history of every change to a player's balances, page by page, with the server API.
- [Inventory API](https://gamecoin.apilow.com/docs/api/inventory.md): List what a player owns, give them items and consume them from your backend with the server API.
- [Purchases API](https://gamecoin.apilow.com/docs/api/purchases.md): Sell an item to a player for virtual currency, debiting the wallet and delivering the item in one step, with the server API.
- [Checkouts API](https://gamecoin.apilow.com/docs/api/checkouts.md): Sell a currency pack for real money by creating an order and sending the player to the hosted payment page, with the server API.
- [Orders API](https://gamecoin.apilow.com/docs/api/orders.md): Follow an order from payment to delivery, and refund a paid order to take its coins and items back, with the server API.
- [Codes API](https://gamecoin.apilow.com/docs/api/codes.md): Let a player redeem a gift code for free coins and items, with the server API or the client API, and read the creator code of an order.
- [Client API](https://gamecoin.apilow.com/docs/api/client.md): The API a browser or a game client calls with a publishable key and a player token, to read, spend, buy and pay without ever crediting a player.

## Machine-readable references

- [OpenAPI 3.1 document](https://gamecoin.apilow.com/api/v1/openapi.json): every route, field and error of the API, without authentication
- [Browser SDK](https://gamecoin.apilow.com/sdk/gamecoin.js): one file, no dependency; its header documents the whole API

## Website

- [Home, French](https://gamecoin.apilow.com): the product in French
- [Home, English](https://gamecoin.apilow.com/en): the product in English
- [Home, Dutch](https://gamecoin.apilow.com/nl): the product in Dutch