Vefþjónustur (API) gera aðildarsöfnum kleift að sækja eða uppfæra gögn úr Sarpi sjálfvirkt, t.d. til birtingar á ytri vef, til tengingar við önnur kerfi eða til gagnasöfnunar og tölfræði. Þetta sparar handvirka vinnu og tryggir samræmda miðlun milli kerfa.
Tveir kostir fyrir aðildarsöfn
- Nota vefþjónustur (API) sem fylgja kerfinu til að sækja/birta gögn á eigin vefum.
- Nota gagnasett sem starfsfólk Sarps skilgreinir fyrir safnið og vinna út frá þeim (einfaldara fyrir marga).
Helstu hugtök
- REST API – algeng samskiptaleið; svör yfirleitt í JSON.
- SOAP þjónusta – eldri staðall; skil oft í XML.
- API-lykill – auðkennir beiðnir (passaðu öryggi).
- Endapunktur (endpoint) – slóð þjónustunnar, t.d.
/api/objects. - Síur/parametrar – móta niðurstöðu, t.d.
?type=myndlist&limit=20.
Skref fyrir skref — Nota vefþjónustu
- Sækja aðgangslykil hjá kerfisstjóra og varðveita örugglega.
- Velja endapunkt miðað við hvaða gögn á að sækja/uppfæra og setja viðeigandi síur.
- Keyra beiðni með Postman eða í forritun (t.d. JavaScript/Python) — setja lykil í haus (Authorization).
- Vinna úr gögnum (JSON/XML) og flytja í vef/kerfi eftir þörf.
Öryggi og verklag
- Geymdu API-lykil á öruggum stað; aldrei í opinberum kóðageymslum eða skjölum.
- Notaðu test-umhverfi og litlar fyrirspurnir til að byrja.
- Skráðu (loggaðu) status-kóða og villur til að auðvelda bilanaleit.
Ábendingar
- Prófaðu fyrst með litlum fyrirspurnum (t.d.
limit=20); stækkaðu síðan skref fyrir skref. - Gættu þess að API-lykill leki ekki (notaðu umhverfisbreytur/leysa úr geymslu).
- Staðfestu heimildir áður en þú byggir á svörum (401/403 → aðgangsmál).
- Vistaðu sniðmát í Postman til endurnýtingar milli verkefna.
Algengar villur
- Rangur/útrunninn API-lykill → þjónustan svarar ekki eða 401/403.
- Rangt snið parametra → engin gögn skila sér.
- Óviðeigandi heimildir → aðgangi hafnað (prófa aðra notendavirkni eða lykil).
Gátlisti
- Ertu með API-lykill og rétt umhverfi/slóð?
- Eru endapunktur og parametrar rétt skilgreind (t.d.
limit,type)? - Seturðu lykil í réttan haus (Authorization) og notar https?
- Geturðu unnið úr JSON/XML svari (vöktun á villum, tómar niðurstöður)?
Sjá einnig
- Vefþjónustur (API) í nýjum Sarpi (MuseumPlus)
Var þessi grein gagnleg?
Það er frábært!
Þakka þér fyrir álit þitt
Því miður! Við gátum ekki verið hjálpleg
Þakka þér fyrir álit þitt
Viðbrögð send
Við kunnum að meta fyrirhöfn þína og munum reyna að laga greinina