Yhdistä työkalusi API:n avulla

API mahdollistaa ulkopuolisen sovelluksen pääsyn organisaationne tietoihin ohjelmallisesti: jäsenistö, kalenterit, varaukset ja laskutus. Se otetaan käyttöön kahdella klikkauksella ja suojataan avaimella, sallittujen osoitteiden luettelolla ja käytön seurannalla.

Selvitä, koskeeko API sinua

API on tarkoitettu kehittäjälle, ei organisaation vastuuhenkilölle. Sen avulla tilinne keskustelee ohjelmiston kanssa, jonka teetätte tai jonka määritätte: räätälöity verkkosivusto, kirjanpito-ohjelma, itse tehty näyttötaulu tai yhdyskäytävä toiseen järjestelmään.

Tavallisiin tarpeisiin — jäsenluettelon noutaminen, tilausten massapäivitys, lukujen toimittaminen johtokunnalle — riittävät tuonti-, vienti- ja raporttitoiminnot ilman ainuttakaan koodiriviä.

API on saatavilla beta-versiona: sen toiminta voi vielä muuttua.

Ota API käyttöön ja hae avaimesi

1. Siirtykää kohtaan Hallinto›Asetukset›API BETA.
2. Aktivoikaa Aktivoi API-moduuli ja klikatkaa sitten Tallenna.
3. API-avain tulee näkyviin: kopioikaa se painikkeella Kopioi ja luovuttakaa se vain sille työkalulle, jonka yhdistätte.

Avain välitetään jokaisen pyynnön HTTP-otsakkeessa X-API-Key. Kutsut on tehtävä aina HTTPS-yhteydellä; salaamattomia pyyntöjä ei hyväksytä.

Suojaa avain

Muutama perusasia kannattaa muistuttaa työkalulle tai palveluntarjoajalle, joka avainta käyttää:

• älkää koskaan tallentakaa avainta koodivarastoon; säilyttäkää se varaston ulkopuolisessa asetustiedostossa tai salaisuuksien hallintapalvelussa;
• rajoittakaa sallitut osoitteet heti, kun työkalu tekee kutsuja kiinteältä palvelimelta;
• luokaa avain uudelleen pienimmästäkin epäilystä — vahinkojulkaisu, lokien vuoto, palveluntarjoajan toimeksiannon päättyminen.

Painike Luo uudelleen pyytää vahvistusta ja mitätöi sitten vanhan avaimen välittömästi. Kaikki sitä käyttäneet sovellukset lakkaavat toimimasta, kunnes ne ovat saaneet uuden avaimen: ilmoittakaa niille ennen klikkausta.

Rajoita käyttöä IP-osoitteella

Aktivoikaa Rajoitus IP-osoitteen perusteella: vain luettelemistanne osoitteista tulevat pyynnöt hyväksytään, enintään 10 IPv4-osoitteen rajoissa. Syöttäkää jokainen osoite ja vahvistakaa painikkeella Lisää; nykyinen osoitteenne näkyy näytöllä avuksenne.

Tämä on tehokkain suojaus ja samalla useimmin laiminlyöty: vaikka avain paljastuisi, palveluntarjoajanne osoitteeseen rajattua avainta ei voi käyttää muualla.

Seuraa käyttöä

Näyttö kertoo jatkuvasti, mitä avaimenne kuluttaa:

• Käyttö tällä hetkellä ja Käyttö tänään, kumpikin suhteutettuna rajaansa, kun raja on määritetty;
• Käyttötilastot: Tämä viikko, Tämä kuukausi, Yhteensä ja Viimeinen pyyntö.

Ilmoitettujen rajojen ylittyessä lisäpyynnöt hylätään väliaikaisesti. Laskuri, joka hipoo jatkuvasti kattoaan, on yleensä merkki huonosti säädetystä työkalusta, joka pyytää samoja tietoja uudelleen ja uudelleen sen sijaan, että tallentaisi ne välimuistiin.

Viimeisen pyynnön päivämäärä on hyödyllinen toiseen suuntaan: avain, joka on aktivoitu mutta jota ei ole kutsuttu kuukausiin, kannattaa poistaa käytöstä.

Tutustu API:n mahdollisuuksiin

Täydellinen dokumentaatio parametreineen ja kutsuesimerkeineen näkyy moduulin näytön alaosassa. Pääpiirteissään:

• Käyttäjät: tämä on ainoa muokattavissa oleva resurssi. Voitte luetella, tarkastella, luoda, muokata ja poistaa tilejä.
• Konfiguraatio: tilauksia, profiileja, ryhmiä ja ikäluokkia voi tarkastella, mutta ne määritetään vain sovelluksessa.
• Varaus: kalentereita, vapaita aikoja, varauksia ja tekstejä voi tarkastella.
• Laskutus: laskutustilejä, tilauksia ja maksuja voi tarkastella.