Skip to content
GAMPEONCreate
New project

Overview

The GAMPEON platform API: accounts, profiles, studios, projects, the server browser, the marketplace, the GAMPEONS wallet, the social layer (follows, friends, posts), jobs and communities with voice channels.

Status: Preview. The API is in a closed test phase and can change without notice.

Conventions

  • Base URL: https://api.gampeon.com. All routes start with /v1.
  • Requests with a body send Content-Type: application/json (file uploads: the file type). Bodies are limited to 64 KB.
  • Times are Unix timestamps in milliseconds (UTC).
  • Errors have the shape { "error": "code", "message": "optional detail" }. Codes are stable, messages are not.
  • Rate limits answer 429 with Retry-After.

Authentication

Log in with POST /v1/sessions and send the token as Authorization: Bearer <token>. Sessions last 30 days. Game servers authenticate heartbeats with x-server-key.

Access tokens (gpat_…, created in the portal or with POST /v1/me/tokens) are sent the same way, but only work on routes that list a scope in x-gampeon-token-scope, and only if the token has that scope (any: every valid token). Every other route, public ones included, answers 403 token_not_allowed when called with an access token; a missing scope 403 insufficient_scope. Tokens never see email addresses and can never moderate, administer, manage tokens, buy, pay, upload versions or delete. Limits per token: 120 requests per minute, 2000 per hour.

Errors on every route

400 invalid_json, 400 body_must_be_object, 400 invalid_field (with a message naming the field), 404 not_found for unknown paths, 405 method_not_allowed, 413 body_too_large, 415 unsupported_media_type, 500 internal_error.

Information

  • OpenAPI version: 3.1.0

Session token from POST /v1/sessions.

Security scheme type: http

Server key from POST /v1/servers. Only for heartbeats.

Security scheme type: apiKey

Header parameter name: x-server-key

Personal access token from the portal or POST /v1/me/tokens. Only for routes with x-gampeon-token-scope; the listed scope is required.

Security scheme type: http

Bearer format: gpat_

Report a problem with this pageOther ways to give feedback