Technical Information

GAIMIN Web2 to Web3 multichain API for games developers

• The GAIMCRAFT API is an HTTP REST API with support for CRUD operations on a wide range of resources.

• Supported Content-Type is application/json

• Supported methods are GET, POST, PUT, DELETE

• Domain for all requests: https://api.gaimin.gg/api/public/v1

Supported chains

Chain Name	Value
Binance Smart Chain (Mainnet)	BSC
Binance Smart Chain (Testnet)	BSC_TESTNET
Polygon (Polygon mainnet)	POLYGON
Mumbai (Polygon testnet)	MUMBAI

Product API Auth

• With no auth

• With apiKey auth

• With user auth (only GAIMIN users)

Response Structure

All responses are wrapped with the following template.

Success response:

{
  "data": {
    "apiKey": "4e172866-5d50-46dd-8c09-061f2519a229"
  },
  "success": true
}

Fail response:

{
  "error": {
    "type": "VALIDATION",
    "description": "Product name 'example product name' is already taken"
  },
  "success": false
}

The GAIMCRAFT API supports both standalone device requests (without a registered user) and user requests (aggregate data for all devices by users).

The GAIMCRAFT Device API requires a JWT Device token which should be provided in the Authorization header as a Device token and is obtains during product registration.

Example:

Authorization: Device eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIzIiwiaWF0IjoiMTYwNzUxMzM1MCJ9.O2aL-9zAA0nm5tctovRhO6fZljLVvVJi3k4vZNcSWYI

The GAIMCRAFT User API requires a Bearer User token which should be provided in the Authorization header as a Bearer token and is obtained from the OKTA service.

Example:

Authorization: Bearer eyJraWQiOiJDWVV2UU45dGE3R2JxVEpGaHdxdzI5VjJVRXVKclpzUEhuZmRaWjNSOHE0IiwiYWxnIjoiUlMyNTYifQ.eyJ2ZXIiOjEsImp0aSI6IkFULnNZck9oOVhiZGk0eVkxN3pVX1lKbjNYM0dTWWtxVmpHNG1RaHk2enFqN0Eub2FyNGJqd2R3VkF3ak5UeVU0eDYiLCJpc3MiOiJodHRwczovL29rdGEuYXV0aGdhaW1pbi5jb20vb2F1dGgyL2RlZmF1bHQiLCJhdWQiOiJhcGk6Ly9kZWZhdWx0IiwiaWF0IjoxNjEyNDM5Njc5LCJleHAiOjE2MTI0NDMyNzksImNpZCI6IjBvYTQzcXB5M2EwOEJzMjF4NHg2IiwidWlkIjoiMDB1MWpxa3dvaTNweGR6UDI0eDciLCJzY3AiOlsib2ZmbGluZV9hY2Nlc3MiLCJvcGVuaWQiLCJwcm9maWxlIl0sInN1YiI6InZvdmFAdGhlcmF2ZW4udGVjaCJ9.PeNZhphX-HX4QA5rcDSH0u_5Bb_jH6uUPydLmRqlyLp0UhGqAcDSbBM5kkznN62MdX5-SLIhQf1IeMvCPMHk3bjs4fhFiRltvDg8A8og1HsxFDiW79zNIGQZn-jsT--awZ3bKJBpxmQPlc7QhtB4rOZthr1q-R3snyJ503DfsVxMZ-wF-NLqVjGTMb2zSq-uXUj6LXIfjjkDr2nsJaxufzLvwl0ixvldLcY1j17_Fy3IQ8HUT_xoX-5taCspUWuFkl4KoIuMI5b9DUl0MY7AEyjqv4bCyxbq4-Dl8SH9wsBkvV_2x7vtJoz6zdM0b-ctBAgLlH1QsV2a8eVmtM_4KQ

The GAIMCRAFT Admin API requires Basic Authorization with Credentials obtained from GAIMIN.

Example:

Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=