Big Bamboo Slot API-dokumentaatio Suomen kehittäjäyhteisön kehittäjille
Tämä dokumentaatio kuvaa Big Bamboo Slot -kolikkopelin rajapinnan ohjelmoijille ja teknologia-kumppaneille. Rajapinta tekee mahdolliseksi pelin upottamisen ja hallinnan ulkopuolisissa alustoissa. Olemme tietoisesti suunnitelleet tämän dokumentin Suomen markkinoiden markkinoiden tarpeisiin, painottaen paikalliset järjestelmästandardit, lainsäädäntövaatimukset ja yleiset integraatiokäytännöt. Käyttöön antamamme API pohjautuu REST-arkkitehtuuriin ja käyttää JSON-muotoista tietoa, mikä helpottaa sen käyttöönottoa. Tästä kyseisestä tekstistä näet tärkeimmät määritelmät, suojausmekanismit, autentikoinnin ja tyypillisimmät skenaariot, jotta kykenet käynnistää yhdistämisesi luotettavasti.
Johdanto Big Bamboo Slot -rajapintaan
Big Bamboo Slot -rajapinta tarjoaa muunneltavat ja suojatut välineet kolikkopelin kytkemiseksi verkkosivuille, mobiilisovelluksiin tai muihin pelialustoihin. Kaikki toiminnot tehdään standardoitujen HTTP-pyyntöjen, kuten GET, POST ja PUT, kautta. Tämä REST-pohjainen menetelmä saa aikaan rajapinnasta kieliriippumattoman, ja se sopii yhteen useimpien nykyaikaisten ohjelmointikehysten kanssa. Suunnittelimme ratkaisun noudattaen Suomen tiukkoja tietosuoja- ja rahapelilakeja. Tietojen siirrossa käytetään salausmenetelmiä, ja pelaajan henkilötiedot käsitellään turvallisesti. Annamme myös täyden testiympäristön (sandbox), jossa voit luoda ja testata integraatiota ilman oikeaa rahaliikennettä. Tämä helpottaa kehitysvaiheen vianetsintää huomattavasti.
Testiympäristö ja testausvaiheen vinkit
Ennen kuin viet integraatiosi tuotantoon, tarkista sitä tarkasti omassa testausympäristössämme (sandbox). Tämä ympäristö on täysin erillään tuotannosta. Se toimii pelirahaa, joten voit testata eri pelimekaniikkoja ja rahaliikenteen käsittelyä vailla todellisia taloudellisia riskejä. Testiympäristön API-avaimet poikkeavat tuotantoavaimista. Noudat ne kirjautumalla kehittäjäportaaliimme. Suosittelemme testaamaan erityisesti alla olevia skenaarioita: epäonnistunut verkkovastaus keskellä talletuksen, pelaajan yhteyden katkeaminen pelin sattuessa, eri voittotilanteiden hoito ja maksimibet-rajojen tarkistus. Tämä edesauttaa varmistamaan, että integraatiosi on luotettava ja antaa luotettavan kokemuksen häiriötilanteissakin.

- Hyödynnä lokitusta: Luo kattava lokitus jokaisesta API-kutsuistasi, niin onnistuneista kuin epäonnistuneista. Se on korvaamaton apuväline vianetsinnässä.
- Jäljittele hidasta verkkoa: Testaa, millä tavalla järjestelmäsi reagoi, kun API-vastaus viivästyy. Hyödynnä timeout- ja uudelleenyritysmekanismeja.
- Tarkista lakisääteiset vaatimukset: Tarkista, että integraatiosi vastaa kaikki mahdolliset Suomen rahapelilainsäädännön vaatimat velvoitteet. Nämä kattavat ikävähennyksen ja peliongelmaresurssien näkyvyyden.
- Suorita kantatestaus: Pyydä ulkopuolista osapuolta, vaikkapa kollegaasi, testaamaan integraatiota toisesta näkökulmasta. He voivat löytää käytettävyysongelmia, mitkä sinulta ovat jääneet huomaamatta.
Keskeiset API-kutsut ja niiden toteutustapa
Tässä esitellään tärkeimmät API-kutsut, jotka tarvitaan pelin saumattomaan integrointiin. Jokainen kutsu vaatii oikein muodostetun JWT-tunnuksen ja osoitetaan osoitettuun päätepisteeseen. Tässä ovat oleellisimmat vaiheet, joilla voit pelin toimimaan ympäristössäsi.
- Pelaajan tunnistaminen ja sessio: Ensin varmistat pelaajan tunnistetiedot ja statuksen järjestelmässämme. Tämä toimenpide suoritetaan käyttäen pelaajan uniikkia tunnistetta.
- Pelin luominen: Seuraavaksi luot tuoreen pelisession, joka linkittää pelaajan tarkkaan pelikertaan. Saat tuloksena uniikin session tunnuksen.
- Pelaamisen käynnistäminen: Vastaanotettuja tietoja hyödyntäen johdat pelaajan suoraan peliin tai lataat pelin iframeen omalle sivustollesi.
- Tilin synkronointi: Teidän on noudettava ja muutettava pelaajan saldoa jatkuvasti reaaliajassa. Hyödynnä tässä erillistä päätepistettä.
- Pelin lopputuloksen raportointi: Kun kierros on ohi, ilmoitat lopputuloksen palautteena järjestelmäämme tapahtumien kirjaamista varten.
Kukin näistä vaiheista on kriittinen. Niiden oikea suorittaminen takaa että pelaaja voi pelata sulavasti, hänen rahansa hoidetaan asianmukaisesti ja jokainen pelitapahtumat ovat avoimia. Tarjoamme kaikille vaiheelle tarkat esimerkkipyynnöt ja -vastaukset kehittäjille tarkoitetussa portaalissa. Voit testata päättelyäsi askel askeleelta niiden avulla. Ota huomioon samoin, että mikäli pelaaja poistuu pelistä aikana kierroksen, teidän on pystyttävä palauttamaan hänet alkuperäiseen tilaan. Tämä toimii tallessa olevan session tunnuksen avulla, hänen palatessaan hän palaa.
API:n perusrakenteen hahmottaminen
Big Bamboo Slot API:n rakenne on selkeä. Oliot, kuten pelihetki, pelaajien tiedot ja pelitapahtumat, ovat saatavilla uniikeilla URI-osoitteillaan. Kelvollinen pyyntö tuottaa HTTP-statuskoodin 200-sarjasta ja vastausdataa JSON-muodossa. Virheiden sattuessa toimitamme kuvaavat virheviestit ja kuvaukset, jotta pystyt tunnistamaan ongelman pikaisesti. Liittymä mahdollistaa laajaa hakumekanismia monille tehtäville, kuten tapahtumahistorialle. Tällä tavalla voit suodattaa tuloksia päivämäärän, rajoituksen tai muun kriteerin mukaan. Tämä johdonmukainen rakenne kohentaa ohjelmoijakokemusta ja systeemin ylläpidettävyyttä.
Endpointit (Endpoints) ja Tietokohteet
Tärkeimmät päätepisteet liittyvät pelikerran käynnistämiseen, pelaajan datan noutamiseen ja pelien tapahtumien merkitsemiseen. Uusi pelikerta tehdään laatimalla POST-pyyntö oikeaan osoitteeseen. Vastauksena saavutat ainutlaatuisen session tunnisteen ja peliin liittymisen edellyttämän URL-osoitteen. Toinen tärkeä päätepiste hoitaa pelaajan saldon tahdistuksesta. Se varmistaa, että näytettävä rahasto on koko ajan ajantasainen eikä pelaaja ylitä sille annettuja rajoituksia. Kaikissa maksuliikenteeseen kytkeytyvissä endpointeissa sovellamme toistotunnistetta. Tämä tunniste torjuu saman transaktion haitallisen uudelleenlähettämisen, mikä on kriittistä rahaan liittyvien operaatioiden virheettömyydelle.
Statuskoodit ja Virheidenkäsittely
Me olemme rakentaneet ymmärrettävän virheenkäsittelyjärjestelmän. Jokainen vastaus sisältää numeerisen statuskoodin ja selkokielisen selityksen. Esimerkiksi koodi 400 osoittaa, että kutsussa oli virhe, kuten uupuuva vaadittu kenttä. Tunnus 401 merkitsee virheellistä autentikointia. Suosittelemme toteuttamaan laajan virhehallinnan asiakaspuolellasi näiden koodien pohjalta. Täten käyttäjäkokemus pysyy miellyttävänä myös odottamattomissa tilanteissa. Tarjoamme myös päätepisteet ylläpidon aikatauluille ja alustan tilalle. Näiden kautta kykenet ennakoida mahdollisia keskeytyksiä ja informoida asiakkaitasi ennakkoon. Tämä avoimuus on olennaista loppukäyttäjien uskollisuuden kehittämisessä.
Suomen lainsäädännön huomioon ottaminen
Suomen rahapelilaki (Rahapelilaki 104/2001) asettaa tarkkoja sääntöjä jokaiselle pelitoimijoille. Nämä kohdistuvat suoraan API-integraatioon. Yksi tärkeimmistä vaatimuksista on ikävähennys. Se takaa, että ainoastaan täysi-ikäiset henkilöt saavat pelaamaan. Liittymäsi on pystyttävä välittämään pelaajan ikätieto turvallisesti alustallemme ennen pelisession avaamista. Seuraava tärkeä vaatimus liittyy peliongelmaisten suojaa. Meidän on annettava selkeät toiminnot peliajan ja tappioiden rajoittamiseen sekä ilmoitettava avun saannista. API-mme tarjoaa rajapinnat, joiden avulla voit hakea ja määrittää pelaajan itsensä valitsemia rajoja. Voit myös näyttää nämä rajat pelaajalle ympäristössäsi. Joka ainoa pelitapahtumat on arkistoitava ja nähtävillä ainakin 12 kuukauden ajan tilitystä varten.
Samoin maksupalveludirektiivi (PSD2) ja vahva asiakastunnistus (SCA) vaikuttavat talletus- ja kotiutusprosesseihin. Vaikkakin nämä prosessit toteutetaan usein maksupalveluntarjoajan kautta, on oleellista, että API-integraatiosi mahdollistaa näiden säädösten vaatimaa turvallisuustasoa. Se edellyttää samoin välttämätöntä tietojen vaihtoa. Ehdotamme tutustumaan Suomen rahapeliviranomaisen, Pelivalvonnan, laatimiin ohjeisiin. Tarkista, että koko pelikokemuksesi – mihin API-integraatio sisältyy oleellisena osana – on vaatimusten kaltainen. Annamme konsultaatiota tehokkaimmista käytännöistä säädösten noudattamiseksi. Käänny meihin yhteyttä, jos sinulla on kysyttävää.
Todennus ja turva
Suojaus on etusijalla kaikissa toiminnassamme. Tämä koskee etenkin Suomen markkina-alueita, joilla edellytykset ovat kireät. Kaiken tuotantoympäristöjen API-kyselyt edellyttävät turvallisen HTTPS-yhteyden. Todennus perustuu JWT (JSON Web Token) -määrittelyyn. Tämä antaa vankan ja skaalattavan menetelmän taata kutsujen aitous. Voit saada henkilökohtaisen API-avaimen sekä salaisuuden kirjautumisen päätteeksi. Näitä tietoja tarvitaan JWT-tokenin luomiseen. Tämä avain liitetään sitten Authorization-headeriin jokaisessa tulevassa API-kyselyssä. Suosittelemme päivittämään API-salasanaasi säännöllisesti. Älä ikinä säilytä sitä selaimen koodissa tai versionhallinnassa. Jokainen henkilökohtaisia tietoja sekä maksuliikennettä käsittävät informaatio salataan hyödyntäen voimakkaita salausalgoritmeja tiedonsiirron aikana.
JWT-tunnusten käyttö
JWT-tunnus on kryptografisesti allekirjoitettu, sekä tämä kattaa vaaditut tieto (claims) käyttäjäprofiilistasi ja hänen oikeuksistaan. Tunnus on pääsääntöisesti voimassa määräaikaisen aikaa, minkä jälkeen se täytyy uusia. Olemme rakentaneet järjestelmän siten, että suojatut, kuitenkin usein toistuvasti pyydetyt operaatiot, esimerkiksi pelitilanne haku, kykenevät käyttää pidemmän kestoaikoja. Rahaliikenteeseen yhdistyvät operaatiot tarvitsevat lyhyempiä sekä useammin uudistettavia tokeneita. Tämä tasapainottaa helppokäyttöisyyttä ynnä turvaa. Tarjoamme myös erillisen päätepisteen tunnuksen uudistamiseen niin, ettei tilin on pakko logata sisään uudelleen. On tärkeää, jotta suoritat tunnuksen hallinnan asiakaspuolellasi turvallisella tavalla. Estä sen tiedon vuotaminen kolmansille osapuolille.
Optimaaliset käytännöt suorituskyvyn optimoimiseksi
Jotta integraatiosi olisi nopea ja luotettava, noudata muutamaa peruskäytäntöä. Suosittelemme toteuttamaan välimuististrategian niille API-kutsuille, jotka eivät sisällä kriittistä reaaliaikadataa. Tällaisia ovat esimerkiksi pelin staattiset asetustiedot tai automaattisesti vanhentuvat mainokset. Välimuisti vähentää tarpeettomia verkkopyyntöjä ja nopeuttaa sivustosi latautumista. Toinen keskeinen tekijä on yhteyksien hallinta. Käytä HTTP-pysyvää yhteystapaa (keep-alive). Se estää toistuvan TCP-yhteyden muodostamisen aiheuttaman ylimääräisen kuorman. Vaikka API-mme on suunniteltu kestämään kuormitusta, suunnittele asiakaspuolesi koodi käsittelemään mahdollisia viiveitä tai väliaikaisia virhetilanteita. Tyylikäs tapa on käyttää eksponentiaalista backoff-uudelleenyritysstrategiaa keskeisissä toiminnoissa.

Suorituskyvyn kannalta on viisasta minimoida samanaikaisten API-kutsujen määrä yhdellä sivulla https://bigbamboo.fi/. Sen sijaan, että tekisit useita erillisiä kutsuja pelaajan saldolle, pelitilalle ja kampanjatiedoille, harkitse oman backend-palvelimesi käyttöä. Se voi koota nämä tiedot yhdellä kutsulla meiltä ja palvella ne asiakkaallesi yhdistetyssä muodossa. Viimeiseksi, seuraa aktiivisesti integraatiosi suorituskykyä tuotannossa. Tuotamme mahdollisuuden saada tilastotietoja API-käytöstäsi kehittäjäportaalissamme. Saatavilla on tietoja kuten pyyntömääriä, keskimääräistä vasteaikaa ja virhemääriä. Näiden tietojen avulla voit tunnistaa trendejä ennen kuin ne muodostuvat ongelmiksi.
Loppupäätelmät ja seuraavat askeleet
Big Bamboo Slot API antaa Suomen kehittäjille työkalut, joilla saadaan aikaan ensiluokkainen ja lakisääteisten vaatimusten mukainen pelikokemus. Käynnistä rekisteröitymällä kehittäjäportaaliimme. Sieltä saat haltuusi pääsyn täydelliseen API-dokumentaatioon, testiavaimet ja hallintapaneelin integraatiosi tarkkailuun. Kehotamme varaamaan aikaa testausympäristössämme. Tuolla pystyt tutustumaan kaikkiin toimintoihin ilman huolia. Olemme täällä auttamassa sinua koko matkan ajan. Älä arkaile kääntyä tekniseen tukeemme, jos kohtaat ongelmia tai sinulla on ajatuksia integraatiosi parantamiseksi. Yhteistyöllä pystymme tarjota Suomen pelaajille varman, viihdyttävän ja sujuvan pelikokemuksen.