Skip to main content

Request URL

  • {host} is the API domain we provide.
  • Example: https://game.bala.jp/vendor/v2.0/member/create

Parameter format

  • GET and DELETE: pass parameters in the query string.
  • Other methods: send parameters as multipart/form-data.

Headers

Every request must include the headers below. For services we provide, you send the token; for services you provide, you verify the token we send.

Connection

Send us the IPs of the servers that call the API so we can add them to the allowlist.

API rules

  • Accounts under different channels are treated as different members. For example, Player001 in channel-1 and Player001 in channel-2 are different members in our system.
  • Channel IDs range from 1 to 2147483647.
  • Each member session is a single, independent connection identified by its own token.
  • While a member plays, the game client refreshes the member’s balance on screen, and checks the balance before every bet.
  • If a member is idle (places no bets) for more than 5 minutes, we close the connection.
  • A member can hold wallets in multiple currencies. Balances cannot be transferred between currencies.
  • Some APIs are rate limited. The limit is stated in each API’s notes; no note means no limit.

Time format

Unless an API states otherwise, times use RFC3339, precise to the millisecond and including the time zone:
Get currency report and Get member report use an hour-precision RFC3339 format, for example 2022-01-01T00+08:00.

Response format

The HTTP status code is always 200. Every response contains data and status; check status.code for the result.
object | string | null
Response data. Its content depends on the API.
object
required
Processing status of the request.
Response example