Games API

Games API Reference - Supplier API

Get a Game URL

POST /game/url HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 346

{
  "user": "john12345",
  "token": "f562a685-a160-4d17-876d-ab3363db331c",
  "sub_partner_id": "my-platform-id",
  "platform": "GPL_DESKTOP",
  "operator_id": 1,
  "meta": {},
  "lobby_url": "https://amazing-platform.com/lobby",
  "lang": "en",
  "ip": "142.245.172.168",
  "game_code": "clt_softwareid",
  "deposit_url": "https://amazing-platform.com/deposit",
  "currency": "EUR",
  "country": "EE"
}
								

Returns the landing URL of the chosen game to which Niropa will forward the user to. There are several ways to forward the User, but make sure game_code is present in the request. 1. Embed URL into iframe on your site; 2. Redirect User to URL; 3. Open URL in new window/tab of browser.

Header parameters
  • uX-Niropa-Signature - any · required

    • RSA-SHA256 is used to sign the request body using the private key. The signature is validated using the public key associated with the provided operator_id.

Body
  • user - string · optional

    • The unique user ID in the Niropa's system. In case of DEMO gameplay, this parameter may be omitted.

    • Example: john12345

  • token - string · max: 255 · optional

    • Niropa generates a token associated with the user, game, and active currency. The token acts as an ID parameter for the game session. It is important that the currency is not changed during the current game session. If the user changes the currency, the game must be re-opened with new a token. For DEMO gameplay, this parameter may be omitted. Minimum length 10 characters, maximum length 255 characters.

    • Example: f562a685-a160-4d17-876d-ab3363db331c

  • sub_partner_id - string · optional

    • ID of an Niropa's sub-partner (brand, whitelabel, site, etc.) which uses the same integration and credentials as the Niropa. Used for detailed reporting and integration type switching.

    • Example: my-platform-id

  • platform - string · enum · required

    • The platform layout, either mobile or desktop, the User has. This property can be ignored, if the mode is chosen based on User's browser attributes (user-agent, resolution, ratio, orientation)

    • Example: GPL_ID

  • operator_id - integer · required

    • The unique identifier of Niropa configuration in the Supplier's system used to authorize incoming requests. Could be either interger or a string.

    • Example: 1

  • meta - object · optional

    • Additional parameters, can be used for certain game Supplier. It depends on the Operator's choice of a game Supplier.

  • lobby_url - string · max: 255 · required

    • lobby_url specifies the URL to which the game redirects to when the user clicks the Home button in the UI. Maximum length 255 characters.

    • Example: https://amazing-platform.com/lobby

  • lang - string · enum · required

    • The ISO 639-1 language code, applicable to the User in the current session.

    • Example: en

    • Available options: aa, ab, ae, af, ak, am, an, ar, as, av, ay, az, ba, be, bg, bh, bi, bm, bn, bo, br, bs, ca, ce, ch, co, cr, cs, cu, cv, cy, da, de, dv, dz, ee, el, en, eo, es, et, eu, fa, ff, fi, fj, fo, fr, fy, ga, gd, gl, gn, gu, gv, ha, he, hi, ho, hr, ht, hu, hy, hz, ia, id, ie, ig, ii, ik, io, is, it, iu, ja, jv, ka, kg, ki, kj, kk, kl, km, kn, ko, kr, ks, ku, kv, kw, ky, la, lb, lg, li, ln, lo, lt, lu, lv, mg, mh, mi, mk, ml, mn, mr, ms, mt, my, na, nb, nd, ne, ng, nl, nn, no, nr, nv, ny, oc, oj, om, or, os, pa, pi, pl, ps, pt, pt-br, qu, rm, rn, ro, ru, rw, sa, sc, sd, se, sg, si, sk, sl, sm, sn, so, sq, sr, ss, st, su, sv, sw, ta, te, tg, th, ti, tk, tl, tn, to, tr, ts, tt, tw, ty, ug, uk, ur, uz, ve, vi, vo, wa, wo, xh, yi, yo, za, zh, zu

  • ip - string · required

    • The user's IP address.

    • Example: 142.245.172.168

  • game_code - string | null · optional

    • The unique game identifier in Provider's system in the form of a string. game_code can be obtained from the /game/list endpoint and is a required parameter.

    • Example: clt_softwareid

  • deposit_url - string · optional

    • The page URL where a user/user can make a monetary deposit.

    • Example: https://amazing-platform.com/deposit

  • currency - string · enum · required

    • The ISO 4217 currency code. The following list contains all currencies supported by our system. Native gameplay support for these currencies may vary per Provider.

    • Example: EUR

    • Available options: BSD, TTD, ZMW, BMD, USD, BYR, UGX, HKD, MGA, GIP, UZS, MKD, PTS, mLTC, EGP, AWG, CZK, ILS, MZN, TND, XPF, SOS, DOP, RUB, KRW, BTN, KGS, BAM, AOA, SOC, AMS, BND, RSD, FKP, PEN, EOS, GHS, JPY, TRY, SBD, UAH, LTL, FJD, GNF, MDL, AFN, ZAR, MOP, TJS, BOB, JMD, QAR, IRR, SYP, XXX, NAD, MYR, CUP, NOK, BGN, KPW, MNT, NZD, uETH, SGD, PYG, OMR, DZD, EUR, TMT, MMK, PTQ, ANG, TZS, CRC, CVE, SET, BTH, BZD, LYD, CHF, MVR, KES, CVE, LSL, KMF, SZL, KYD, BRL, AED, WST, YER, ALL, TRX, HUF, GTQ, uBTC, IDR, MWK, CUC, DKK, TWD, XCD, BBD, LRD, KZT, JOD, BYN, BIF, PLN, SDG, VUV, SEK, BDT, HNL, BWP, VND, ISK, SLL, BHD, HTG, USDt, ADA, MUR, ERN, uLTC, LKR, COP, GEL, AUD, GBP, CAD, PHP, PAB, DJF, GMD, PKR, NIO, AMD, RWF, RON, NGN, TOP, UYU, AZN, SRD, KWD, PGK, CDF, SAR, IQD, XRP, SCR, mETH, MAD, GYD, INR, LBP, ARS, MXN, CLP, BNB, CNY, KHR, LAK, HRK, BZD, SSP, XOF, XAF, MRU, NPR, mBTC

  • country - string · enum · required

    • The ISO 3166-1 country code, applicable to the User in the current session.

    • Example: EE

    • Available options: XX, AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW

Responses
{"url":"https://the-best-game-provider.com/the-game?session=d4d73882-b3fb-11e7-a3a6-58404eea6d16"}
{"error":"The `operator_id` does not correspond to any existing Operators."}

Get a Game round


POST /game/round HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "user": "john12345",
  "transaction_uuid": "16d2dcfe-b89e-11e7-854a-58404eea6d16",
  "round": "rNEMwgzJAOZ6eR3V",
  "operator_id": 1
}
								

API to return details of a game round.

Header parameters
  • uX-Niropa-Signature - any · required

    • RSA-SHA256 is used to sign the request body using the private key. The signature is validated using the public key associated with the provided operator_id.

Body
  • user - string · optional

    • The unique user ID in the Niropa's system. In case of DEMO gameplay, this parameter may be omitted.

    • Example: john12345

  • transaction_uuid - string · optional

    • The transaction identifier, which you recive from Niropa through the API during gameplay.

    • Example: 16d2dcfe-b89e-11e7-854a-58404eea6d16

  • round - string · optional

    • The round identifier, which you recive from us through the API during a gameplay.

    • Example: rNEMwgzJAOZ6eR3V

  • operator_id - integer · required

    • The unique identifier of Niropa configuration in the Supplier's system used to authorize incoming requests. Could be either interger or a string.

    • Example: 1

Responses
{"url":"https://the-best-game-provider.com/roundCheck?round=rNEMwgzJAOZ6eR3V"}
{"url":"https://error-page.host/error?message=round-is-still-unfinished"}

Get a list of games


POST /game/list HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "operator_id": 1
}
								

Returns Supplier's game list available for Niropa.

Header parameters
  • uX-Niropa-Signature - any · required

    • RSA-SHA256 is used to sign the request body using the private key. The signature is validated using the public key associated with the provided operator_id.

Body
  • operator_id - integer · required

    • The unique identifier of Niropa configuration in the Supplier's system used to authorize incoming requests. Could be either interger or a string.

    • Example: 1

Responses
[
  {
    "url_thumb": "https://picture-hosting.com/blackjack/thumb.png",
    "url_background": "https://picture-hosting.com/blackjack/bg.png",
    "product": "OneTouch",
    "platforms": [
      "GPL_DESKTOP",
      "GPL_MOBILE"
    ],
    "name": "Classic",
    "game_code": "ont_classic",
    "reward_support": true,
    "enabled": true,
    "category": "Blackjack",
    "blocked_countries": [
      "PL",
      "BG"
    ]
  }
]