Sovellusrajapinta
Älykästä automaatiota seuran tarpeisiin
Onko seurallanne erityistarpeita, joita myClubin lisäpalvelut eivät kata? Ei hätää – myClubin sovellusrajapinnan (API) avulla voitte yhdistää ulkoisia järjestelmiä tai rakentaa omia ratkaisuja juuri teidän tarpeisiinne. Automatisoi arki, vähennä manuaalista työtä ja yhdistä järjestelmät toimimaan saumattomasti yhteen.
Käyttöönotto
Aktivoi sovellusrajapinta-lisäpalvelu seuraavasti:
- Siirry kohtaan Asetukset > Lisäpalvelut > Hallinta
- Klikkaa Sovellusrajapinta-lisäpalvelu ja paina Aktivoi lisäpalvelu
Sovellusrajapinta-lisäpalvelu on nyt aktivoitu.
API-avaimen luominen
- Mene kohtaan Asetukset > Lisäpalvelut > Sovellusrajapinta
- Klikkaa painiketta Luo uusi rajapinta-avain
- Määritä rajapinta-avaimen asetukset:
Perusasetukset
- Jäsen: Valitse, mihin jäsentiliin rajapinta-avain kiinnitetään. Rajapinta-avaimen oikeudet seuran toimintoihin määräytyvät jäsentilille määritellyn käyttöoikeusroolin mukaan (Asetukset > Roolit).
Avaimen nimi: Nimeä avain siten, että muistat, mihin tarkoitukseen sitä käytetään.
Tila:
- Käytössä – avain on aktiivinen
- Pois käytöstä – avain ei toimi
Rajoitukset – Luku- ja kirjoitusoikeudet
- Vain lukuoikeudet: Rajapinta mahdollistaa vain tietojen lukemisen järjestelmästä.
- Luku- ja kirjoitusoikeudet: Rajapinta mahdollistaa sekä lukemisen että kirjoittamisen.
Rajoitukset – Jäsentietojen näkyvyys
- Ei mitään: Rajapinnan kautta ei saada jäsentietoja.
- Kaikki: Rajapinnasta saadaan kaikki jäsentiedot, paitsi arkaluontoisiksi määritellyt kentät.
- Valitut: Rajapinnasta saadaan vain valitut jäsenkenttätiedot. Voit valita kaikista kentistä, lukuun ottamatta arkaluontoisia.
- Paina Tallenna
Rajapinta-avain on nyt luotu.
Rajapinta-avaimen hallinta
Saat rajapinta-avaimen tunnisteen haltuusi kirjautumalla jäsentiliin, johon avain on kiinnitetty:
- Klikkaa toimintovalikkoa (jäsentilin nimi)
- Valitse Rajapinta-avain
- Klikkaa Näytä ja kopioi avaimen tunniste
Tietoturvahuomio:
Älä koskaan lähetä rajapinta-avainta sähköpostitse tai jaa sitä muille. Avaimen tulee pysyä luottamuksellisena. Jos epäilet, että avain on vaarantunut, luo välittömästi uusi avain.
Ohjelmistorajapinnan dokumentaatio
Löydät rajapinnan mahdollistamat toiminnot ja niiden kuvaukset täältä: https://taikala.github.io/myclub-api-docs/fi
Järjestelmässä ei ole tarjottavana testiympäristöä.
Huomioithan, että koska kyseessä on asiantuntijatason ohjelmistokehitysrajapinta, jonka avulla voidaan toteuttaa täysin seurakohtaisia ratkaisuja, ei ohjelmistorajapinnan käyttö kuulu maksuttoman tuotetuen piiriin.
API-avaimen poistaminen
Jos haluat poistaa rajapinta-avaimen kokonaan, toimi seuraavasti.
- Mene kohtaan Asetukset > Lisäpalvelut > Sovellusrajapinta
- Valitse poistettava rajapinta-avain taulusta ja käytä taulukkotoimintoa Valitse toiminto > Poista