Skjölun fyrir vefþjónustu Spara

Tengdu þínar hugbúnaðarlausnir við Spara!

Hér má sjá þá valmöguleika sem eru í boði til þess að halda meðlimahópum uppfærðum í Spara.

Ef þú ert með einhverjar spurningar, hafðu samband við okkur í gegnum tölvupóst: spara@spara.is eða í síma 546-1819

Stjórnun hóps í gegnum API

Endapunktar til að gefa hópmeðlimum aðgang að hóp og fjarlægja þá úr hóp. Þessir endapunktar krefjast gilds Bearer token í Authorization header sem tengdur er ákveðnum hóp. Hafðu samband við okkur til að fá aðgang.

Hámarksfjöldi beiðna (Rate Limit): Hámark 500 beiðnir á mínútu per Bearer token og IP tölu. Vefþjónustan svarar 429 Too Many Requests ef farið er yfir það.
POST Gefa meðlimi aðgang að hóp
▼
https://api.spara.is/api/group/member/{phoneorkennitala}
Bætir nýjum meðlimi í hóp út frá símanúmeri eða kennitölu.
Auðkenning: Authorization: Bearer {YOUR_ACCESS_TOKEN}
Hafið í huga:
• Símanúmer og kennitölur geta verið með eða án bandstrika og bila
• 7 stafa númer eru túlkuð sem símanúmer
• 10 stafa númer eru túlkuð sem kennitölur
Notkunardæmi:
curl -X POST "https://api.spara.is/api/group/member/8888888" \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \ -H "Content-Type: application/json"
Parameter Tegund Lýsing
phoneorkennitala path parameter Símanúmer (7 stafir) eða kennitala (10 stafir)

Svör:

200 OK Meðlimi bætt við
{ "message": "Member Added", "results": "Success", "error": false, "code": 200 }
200 OK Meðlimur á nú þegar aðgang
{ "message": "Member already has access", "results": "Already has access", "error": false, "code": 200 }
400 Error Villa í beiðni
{ "message": "Error message", "error": true, "code": 400, "results": [] }
401 Error Ógildur eða vantar Bearer token
{ "message": "Authorization Bearer token is required", "error": true, "code": 401, "results": [] }
404 Error Meðlimur fannst ekki
{ "message": "Member not found or no changes made", "error": true, "code": 404, "results": [] }
429 Error Of margar beiðnir (rate limit)
{ "message": "Too many requests. Please try again later.", "error": true, "code": 429, "results": [] }
DELETE Fjarlægja meðlim úr hóp
▼
https://api.spara.is/api/group/member/{phoneorkennitala}
Fjarlægir meðlim úr hóp út frá símanúmeri eða kennitölu.
Auðkenning: Authorization: Bearer {YOUR_ACCESS_TOKEN}
Hafið í huga:
• Símanúmer og kennitölur geta verið með eða án bandstrika og bila
• 7 stafa númer eru túlkuð sem símanúmer
• 10 stafa númer eru túlkuð sem kennitölur
• Aðeins er hægt að fjarlægja meðlimi sem eru þegar í hópnum
Notkunardæmi:
curl -X DELETE "https://api.spara.is/api/group/member/8888888" \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \ -H "Content-Type: application/json"
Parameter Tegund Lýsing
phoneorkennitala path parameter Símanúmer (7 stafir) eða kennitala (10 stafir)

Svör:

200 OK Meðlimi fjarlægður
{ "message": "Member Removed", "results": "Success", "error": false, "code": 200 }
401 Error Ógildur eða vantar Bearer token
{ "message": "Authorization Bearer token is required", "error": true, "code": 401, "results": [] }
404 Error Meðlimur fannst ekki
{ "message": "Member not found", "error": true, "code": 404, "results": [] }
429 Error Of margar beiðnir (rate limit)
{ "message": "Too many requests. Please try again later.", "error": true, "code": 429, "results": [] }

External Validation

Annar möguleiki er að þið setjið upp endapunkt í ykkar kerfi sem getur svarað hvort símanúmer/kennitala eigi að fá aðgang að hópnum. Spara mun kalla í þennan endapunkt í hvert sinn sem notandi opnar appið til að staðfesta aðild.

Hvernig virkar þetta?
Spara kallar í ykkar vefþjónustu (API) þegar notandi opnar appið. Ykkar vefþjónusta athugar hvort notandinn hefur aðgang að hópnum og svarar já eða nei.

Dæmi um endapunkta sem Spara gæti kallað í

GET https://your-api.example.com/api/isMemberKennitala/{kennitala}
GET https://your-api.example.com/api/isMemberPhone/{phone}

Dæmi um svör

Notandi á að fá aðgang að hópnum:
{"valid": true}
Notandi á ekki að fá aðgang að hópnum:
{"valid": false}
ATH: Endanleg útfærsla er sveigjanleg svo lengi sem hægt er að ákvarða já/nei niðurstöðu. T.d. með length !== 0 eða id === undefined sem dæmi.
Advania Logo

Tengja H3 frá Advania

Hægt er að tengja Spara hóp við H3 mannauðslausn Advania svo að meðlimir haldist uppfærðir með reglulegri sjálfvirkri uppfærslu. Ef þið viljið nýta þessa tengingu, hafið samband við okkur.

Hvernig virkar tengingin?
• Spara auðkennir sig gagnvart H3 og sækir lista yfir starfsfólk.
• Spara skoðar breytingar á lista starfsfólks og samstillir það við meðlimahóp Spara.
• Spara keyrir þessa aðgerð 1 sinni á viku eða eftir samkomulagi.
Hafa samband: spara@spara.is · 546-1819