PIN-kode API

arkon har et eget API for å generere PIN-koder som kan benyttes av andre systemer. Eksempler er systemer som oppretter medlemskort, adgangskoder etc. Styrken med denne flyten er at du bruker arkon til å administrere personene og ta inn registreringer, også kan et annet system bruke dette APIet for å opprette PIN-koder og legge disse inn i sitt system. Ta kontakt med oss hvis du vil diskutere hvordan dette kan brukes hos deg.

Nedenfor følger den tekniske beskrivelsen på hvordan man skal integrere med APIet, teksten forutsetter utviklerkompetanse og basisforståelse av APIer og HTTP. Dette APIet er av historiske årsaker XML-basert, alle andre arkon APIer benytter JSON.

Autorisasjon

For å kunne hente ut informasjon fra APIet trenger du en API-nøkkel, denne har en viss varighet og kan kun benyttes på ett arrangement. API-nøkkelen er en JWT og du legger denne i Authorization headeren på alle API kall slik (nøkkel forkortet for eksempelets skyld):

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50X2lkIjo1LCJ

Endepunkter

Hent PIN-koder

Du kan hente allerede genererte PIN-koder med et enkelt GET kall

GET https://api.arkon.no/public/pin

<?xml version="1.0" encoding="UTF-8"?>
<pinCodes accountId="5" number="2">
 <pin personId="501810" created="2017-12-18 08:46:51" fname="Ola" lname="Nordmann">9882</pin>
 <pin personId="1463" created="2017-12-18 08:41:14" fname="Lise" lname="Nordmann">7784</pin>
</pinCodes>

Kode-eksempel i curl:

curl -X GET \
https://api.arkon.no/public/pin \
 -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50X2lkIjo1LCJ0b2tlbl9pZCI6ImZjMzkwZmNhLWUzNDYtMTFlNy04ZWYwLWFjYmMzMmMwM2Q4NSIsInNjb3BlcyI6WyJwdWJsaWMiXX0.h68oKacwT2WPvG5vMfNfah3yEyy1UHHRGqzrrix1ipE'

Opprette nye PIN-koder

For å opprette PIN-koder har man noen alternativer man må tenke på:

• Hvem skal det opprettes PIN-kode for (angis som en eller flere kategorier eller hovedkategorier i arkon)
• Skal det sendes ut varsel om PIN-kode (bare SMS er støtte akkurat nå, ta kontakt hvis det er behov for andre metoder)

Flyten er at man sender et POST kall med en XML-konfigurasjonen på hvilke kategorier det skal opprettes koder for, samt informasjon om utsendelse. arkon vil da opprette kodene og sende ut på angitt måte. Merk at arkon vil opprette maksimalt 500 koder per request, så hvis du tror det kan være flere bør du gjøre flere kall til du får tilbake 0 koder som svar.

Eksempel på konfigurasjon ser man under. APIet vil da returnere en liste (lik den i GET PIN-kode) for alle pin-koder som ble opprettet denne gangen. Hvis man ikke ønsker at det skal sendes SMS så bare ekskluderer man <communications> taggen.

<?xml version="1.0" encoding="UTF-8"?>
<request>
  <receivers>
    <receiver type="main_category_id">32323</receiver>
    <receiver type="category_id">455</receiver>
  </receivers>
  <communications>
    <message type="sms">Her er din PIN-kode [pin]</message>
    </communications>
</request>

Kodeeksempel i curl:

 curl -X POST \
 https://api.arkon.no/public/pin \
 -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50X2lkIjo1LCJ0b2tlbl9pZCI6ImZjMzkwZmNhLWUzNDYtMTFlNy04ZWYwLWFjYmMzMmMwM2Q4NSIsInNjb3BlcyI6WyJwdWJsaWMiXX0.h68oKacwT2WPvG5vMfNfah3yEyy1UHHRGqzrrix1ipE' \
 -H 'Content-Type: text/xml' \
 -d '<?xml version="1.0" encoding="UTF-8"?>
<request>
 <receivers>
 <receiver type="main_category_id">32323</receiver>
 <receiver type="category_id">455</receiver>
 </receivers>
 <communications>
 <message type="sms">Her er din PIN-kode [pin]</message>
 </communications>
</request>
'