GIF EkBi API - Utvecklarportal

Välkommen till utvecklarportalen för GIF EkBi API. Här hittar du information om hur du ansluter till API:et, tillgängliga miljöer och aktuell status.

Inledning

GIF EkBi API agerar som en aggregerande mellanhand mot en rad olika organisationer och myndigheter, kallade “Uppgiftslämnare”. Tanken med detta nya API är att det ska ersätta SSBTEK i att leverera denna funktionalitet. Det övergripande konceptet för API:t är att det inte bara aggregerar information, utan dessutom normaliserar - vilket är den stora skillnaden mot SSBTEK som inte gör någon transformering av svaret från uppgiftslämnarna.

Normaliseringen innebär att vi definerar upp en rad olika Informationsmängder (datamodeller) som ska kunna härbärgera de olika typerna av information som är relevanta i ett EkBi-sammanhang. Exempel är Utbetalningar, Beslut, Tillgångar och Skulder. Uppgiftslämnarna har egna strukturer för denna information, så normaliseringen innebär att vi transformerar dessa strukturer till den nya för att göra EkBi-API:t mer lättkonsumerat. En Utbetalning ser alltid likadan ut oavsett vilken uppgiftslämnare som är dess ursprung. Informationsmängdernas datastrukturer finns definerade i OpenAPI-specifikationen nedan.

Vi är alltid intresserade av feedback på API:t. För att ge feedback eller för tekniska frågor rörande integrationen, maila GIF-EKBI@inera.se.

OAuth 2.0 client-registrering

För att få tillgång till API:t behöver anslutande system en OAuth 2.0-klient. För att få behörighet, skicka ett mail till GIF-EKBI@inera.se med följande uppgifter:

• Miljö - Vilken miljö som access efterfrågas till. Just nu finns endast AT.

• Kommun/leverantör – Vilken kommun eller leverantör klienten tillhör.

• Kontaktperson – Namn och e-postadress till ansvarig kontaktperson.

Just nu registrerar vi endast klienter för verksamhetssystem, inte för e-tjänster. När ni fått tillgång till era användare kan ni gå in på https://gif-at.inera.se/admin och hitta era nycklar.

Testmiljö för acceptanstest (AT)

Syftet med testmiljön är tvådelad:

1. Utvecklare av E-tjänster och verksamhetssystem ska kunna testa sin integration.

2. Verksamheten ska kunna ge feedback på den data och struktur som APIt svarar med.

Endpoints

Se OpenAPI-specen nedan för information om vilka endpoints som finns, hur de anropas och vilken data de svarar med.

Autentisering

Klienter för verksamhetssytem autentiserar sig med hjälp av flödet OAuth 2.0 Client Credentials. Den resulterande access token ska bifogas som Bearer i Authorization-headern.

OAuth 2.0 well known endpoint: https://auth.gif-at.inera.se/realms/gif/.well-known/openid-configuration

Nedan kommer ett exempel på hur man kan plocka ut en giltig access_token utifrån de konton som ni blivit tilldelade ovan:

Med den access_token kan ni sedan anropa GIF API med valfritt verktyg, eller köra nedanstående:

Observera

AT-miljön är en Q1-leverabel och i sitt första stadie under Q2 kan vi inte garantera tillgänglighet och stabilitet.

Testmiljön är dessutom under ständig utveckling och kan komma att förändras med kort förvarning.

Testdata i testmiljön hämtas från SSBTEKs testmiljö och kan vara inkonsekvent, felaktig och sakna respekt för efterfrågad period. Förbättrad testdata finns på roadmap.

Aktuell status

Informationsmängder

Informationsmängder är de olika typer av basmodeller som API:t exponerar. Alla uppgiftslämnare delar samma informationsmängder, det finns alltså inte en FK-utbetalningsmodell och en annan CSN-utbetalningsmodell.

Uppgiftslämnare

Vissa informationsmängder kan saknas från nedanstående uppgiftslämnare. Tabellen visar endast vilka uppgiftslämnare som vi hämtar information från, inte om informationsmängden är komplett.

Förklaring av statusar: