FloMembersin API-rajapinta
Ominaisuus vaatii vähintään FloMembers Medium -version.
FloMembers-jäsenrekisterin ohjelmointirajapinnan (REST-API) kautta jäsenrekisteri voidaan integroida muihin järjestelmiin. API:n käyttö vaatii validin API-avaimen, jotta väärinkäytöksiltä vältytään.
Mihin rajapintaa voi käyttää?
Rajapinnan käyttötarkoituksia on monia. Se soveltuu esimerkiksi tapauksiin, joissa järjestön verkkosivustolla halutaan esittää joitakin jäsenten tietoja vaikkapa postinumeron avulla haettuna.
Muita esimerkkejä ovat jäsenen kirjautumisoikeuden tarkistaminen rajapinnasta sähköpostiosoitteen avulla tai jäsenistön keskimääräisen iän laskeminen.
API tarjoaa datan JSON-muodossa.
Tarvittaessa kolmannen osapuolen järjestelmä voi myös luoda jäsenrekisteriin uusia henkilöitä tai päivittää olemassa olevia tietoja API:n yli. Kirjoitusoikeus aktivoidaan erikseen; oletusarvoisesti kirjoitusoikeutta ei ole sallittu.
Miten voin käyttää rajapintaa?
Oletusarvoisesti FloMembersin rajapintaa ei ole aktivoitu.
Jos haluat rajapinnan käyttöön, jätä uusi tukipyyntö ja kerro, miten haluaisit hyödyntää rajapintaa. Voimme tällöin antaa tarkemmat ohjeet ja asettaa kentät, joiden tietoja voidaan hakea.
Rajapinnan mahdolliset räätälöinnit laskutetaan tuntityönä. Kun rajapinta on aktivoitu, API-rajapinnan Swagger-dokumentaatio on luettavissa jäsenrekisterin oikean alakulman kysymysmerkkipainikkeen kautta.
Mitä toimintoja rajapinta tukee?
| Data | CRUD | Huomautukset | Esimerkki |
|---|---|---|---|
| Henkilöt | Create, Read, Update | Resign request | GET /demo/api/v1/persons?api_key=123 |
| Laskut | Create, Read, Update | GET /demo/api/v1/invoices?api_key=123 | |
| Tapahtumat | Read | Tarjoaa vain julkiset tapahtumat | GET /demo/api/v1/events?api_key=123 |
| Yhteydet | Read | GET /demo/api/v1/connections?api_key=123 |
Esimerkki JSON-muotoisesta jäsendatasta
[ { "id": 1, "lastname": "Esimerkki", "firstname": "Ella", "email": "ella.esimerkki@esimerkki.fi", "mobile": "+358402121212", "address": "Esimerkkitie 85", "postcode": "00100", "postoffice": "HELSINKI", "employer": "Oma yritys", "avatar": "/assets/2026147e.jpg?v=1642539506", "custom_1": null, "custom_2": "Kiinnostuksen kohteet.", "custom_3": null, "_links": { "self": { "href": "/api/v1/persons/1?api_key=xx" } } }]