API


X-ref har ett kraftfullt api vilket gör det möjligt att integrera X-ref med andra system. Via X-refs api kan du söka, ändra, skapa och radera dokument.


e-arkiv api
API till ditt e-arkiv

Systemadministratören kan begränsa behörigheten för apianvändaren så att användaren endast kan uppdatera/radera dokument som användaren skapat själv eller dokument som skapats av användare ur samma användargrupp. Systemadministratören kan också av säkerhetsskäl begränsa antal möjliga anrop per given tidsenhet.


Dokumentation utdrag:


Ett anrop till api:et kan se ut så här:

myurl.se/api/v1/docs?find=TI:sweden,YE:2010

Detta är ett sökanrop efter alla dokument som har sweden i titelfältet (TI) och 2010 i årfältet (YE).


Svaret skulle kunna se ut så här (json):

{ "nextPageUrl": "myurl.se/api/v1/docs?find=TI:Sweden,YE:2010&page=2",
"numberOfHits": 40,
"currentPage": 1,
"numberOfPages": 4,
"docs": [
   {
    "fields": [
     {
      "code": "HitNr",
      "value": "1"
     },      {       "code": "DocumentID",
      "value": "1909"
     },
     {
      "code": "TI",
      "value": "My fantastic time in Sweden"
     },
     {
      "code": "AU",
      "value": "Sven Svensson"
     },
     {
      "code": "KEY",
      "value": "Travel ; Sweden ; Swedish culture"
     },
     {
      "code": "YE",
      "value": "2010"
     }
    ],
    "url": "myurl.se/api/v1/docs/1909"
  },
  {
    "fields": [
     {
      "code": "HitNr",
      "value": "2"
     },
     {
      "code": "DocumentID",
      "value": "1922"
     },
etc...
Läs vidare: Wikipedias definition av API