API Dokumentation - Hämta e-tjänster
I Open ePlatform finns det ett API som kan användas av externa system för att hämta ut information och länkar till e-tjänster inom en Open ePlatform-installation. Detta kan exempelvis användas för att lista e-tjänster på en separat hemsida.
API:et har stöd för att returnera information i XML-, JSON- och JSONP-format.
API:et har stöd för följande:
- Hämta alla e-tjänster
- Hämta alla kategorier av e-tjänster
- Hämta alla e-tjänster inom en specifik kategori
- Hämta en specifik e-tjänst
- Hämta de mest använda e-tjänsterna
Nedan beskrivs varje funktion mer detaljerat.
Allmänt
Adress (URL) till API beror på hur modulen konfigureras och den domän som installationen körs på.
Strukturen på anrop är följande:
URL/version/anrop/parameter/format
Exempelvis:
https://exempel.se/api/v1/getflowsincategory/3/json
Hämta alla e-tjänster
Returnerar samtliga publicerade e-tjänster.
Anrop
- XML: /v1/getflows/xml
- JSON: /v1/getflows/json
- JSONP: /v1/getflows/jsonp?callback=foo
Parametrar
Önskat format på svar anges som parameter i slutet av URL (stöd finns för XML, JSON, JSONP).
Hämta alla kategorier av e-tjänster
Returnerar samtliga kategorier av e-tjänster som är upplagda.
Anrop
- XML: /v1/getcategories/xml
- JSON: /v1/getcategories/json
- JSONP: /v1/getcategories/jsonp?callback=foo
Parametrar
Önskat format på svar anges som parameter i slutet av URL (stöd finns för XML, JSON, JSONP).
Hämta alla e-tjänster inom en specifik kategori
Returnera samtliga publicerade e-tjänster inom en specifik kategori.
Anrop
- XML: /v1/getflowsincategory/3/xml
- JSON: /v1/getflowsincategory/3/json
- JSONP: /v1/getflowsincategory/3/jsonp?callback=foo
Parametrar
Ange vilken kategori som du vill lista e-tjänster från genom att ange id för denna kategori som en parameter efter ”getflowsincategory/”. Exempelvis getflowsincategory/3/ för att lista alla e-tjänster inom kategori 3.
Tips, använd anropet ” Hämta alla kategorier av e-tjänster” (getcategories) först för att lista alla kategorier som finns tillgängliga.
Önskat format på svar anges som parameter i slutet av URL (stöd finns för XML, JSON, JSONP).
Hämta en specifik e-tjänst
Returnerar en specifik e-tjänst.
Anrop
- XML: /v1/getflow/122/xml
- JSON: /v1/getflow/122/json
- JSONP: /v1/getflow/122/jsonp?callback=foo
Parametrar
Ange vilket id den specifika e-tjänsten har som parameter efter ” getflow/”. Exempelvis ” getflow/122/” för att hämta ut e-tjänst 122.
Tips, använd anropet ”Hämta alla e-tjänster” (getflows) för att lista alla e-tjänster först, så att du hittar rätt id för den e-tjänst du önskar hämta den vägen först.
Önskat format på svar anges som parameter i slutet av URL (stöd finns för XML, JSON, JSONP).
Hämta de mest använda e-tjänsterna
Returnerar de mest använda e-tjänsterna.
Anrop
- XML: /v1/getpopularflows/5/xml
- JSON: /v1/getpopularflows/5/json
- JSONP: /v1/getpopularflows/5/jsonp?callback=foo
Parametrar
Ange antalet e-tjänster du vill få med i svaret genom att definiera antalet efter ”getpopularflows/”, exempelvis ” getpopularflows/5” för att lista de fem mest använda e-tjänsterna.
Önskat format på svar anges som parameter i slutet av URL (stöd finns för XML, JSON, JSONP).
