Miten lähetän NPS-kyselyn rajapinnan avulla?
1) Aloita luomalla uusi NSP-kysely. Valitse Käyttö rajapintakutsuissa sallittu. Alla näet rajapintakutsussa tarvittavan URL-osoitteen sekä API-avaimet. Mikäli sinulla ei ole vielä API-avainta, jolla NPS-sovelluksen käyttö on sallittu, voit luoda uuden klikkaamalla API-avaimet (avautuu uudelle välilehdelle). Mikäli sinulla on jo API-avain voit siirtyä suoraan ohjeen kohtaan 3).
2) Luo uusi API-avain API-avainten hallinta -välilehdellä valitsemalla Luo uusi API-avain. API-avain ilmestyy listaan ja pääset katsomaan tarkempia tietoja sekä tekemään muokkauksia klikkaamalla kynä-ikonia. API-avaimessa on oletuksena NPS-kyselyn käyttöoikeus, joten voit jatkaa NPS-kyselyn luomista. Siirry takaisin kyselyn luomiseen, listassa pitäisi nyt näkyä juuri luotu API-avain (mikäli lista on tyhjä, kokeile päivittää sivu). Luo kysely loppuun ja valitse Käynnistä.
3) Luotuasi NPS-kyselyn, tarkastele juuri luomaasi tapahtumaa napsauttamalla kynä-ikonia. Löydät jatkossa tapahtuman valitsemalla vasemmasta valikosta Tapahtumat.
4) Tapahtuman tiedoista löydät kyseisen tapahtuman URL-osoitteen sekä API-avaimen.
5) Lisää vastaanottajia käynnissä olevaan kyselyyn NPS-rajapinnan dokumentaation mukaisesti (Add recipient). Aina kun uusi vastaanottaja lisätään kyselyyn, lähetetään kysely saman tien tekstiviestinä puhelimeen.
Korvaa esimerkkikoodista example.com/v2/npssurvey/applicationevent_key tapahtuman URL-osoitteella, esim. smsapi.quriiri.fi/v2/npssurvey/7f543da5-a12d-4a15-ab8b-2126cec68399
Korvaa Bearer numero API-avaimella, esim. ’Authorization: Bearer c28ae121-31f5-4557-af43-4ca528a5143d’.
Eli esimerkki:
curl --request PUT \
--url https://example.com/v2/npssurvey/applicationevent_key/add_recipient \
--header 'Accept: application/json' \
--header 'Authorization: Bearer 123' \
Näyttäisi tältä:
curl --request PUT \
--url https://smsapi.quriiri.fi/v2/npssurvey/7f543da5-a12d-4a15-ab8b-2126cec68399/add_recipient \
--header 'Accept: application/json' \
--header 'Authorization: Bearer c28ae121-31f5-4557-af43-4ca528a5143d'\
6) Voi myös hakea rajapinnan kautta tapahtuman statuksen (Get Status), tilastot (Get Statistics), tulokset (Results) sekä yksittäisen numeron antaman palautteen (Result).