API Reference

Complete reference for Game Framework REST API.

Getting Started

The Game Framework API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Base URL

https://registry.yourcompany.com/v1

Authentication

curl https://registry.yourcompany.com/v1/packages \
  -H "Authorization: Bearer YOUR_TOKEN"

See Authentication.

Resources

Core Resources

• Packages - Manage Flutter packages
• Versions - Package versions
• Artifacts - Package files
• Workspaces - Team workspaces

Additional Resources

• API Keys - Authentication keys
• Webhooks - Event notifications

Quick Examples

Create Package

curl -X POST https://registry.yourcompany.com/v1/workspaces/ws_ID/packages \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my_package",
    "description": "My Flutter package"
  }'

List Packages

curl https://registry.yourcompany.com/v1/workspaces/ws_ID/packages \
  -H "Authorization: Bearer $TOKEN"

Get Package

curl https://registry.yourcompany.com/v1/packages/pkg_ID \
  -H "Authorization: Bearer $TOKEN"

SDKs & Libraries

• Dart/Flutter - Official SDK (coming soon)
• Go - Official SDK (coming soon)
• TypeScript/Node.js - Community SDK

API Basics

• Overview - API fundamentals
• Authentication - Auth methods
• Rate Limiting - Rate limits
• Error Codes - Status codes

Endpoints

• Packages
• Versions
• Artifacts
• Workspaces
• API Keys
• Webhooks