...
Version | Datum | Kommentar |
|---|---|---|
1.0 (2022) | 2022-02-28 | Beslutad version 1.0 för Tjänsten Säker digital kommunikation. |
1.1 (2023) | 2023-02-14 | Uppdateringar: |
1. Inledning
SDK Adressbok:s Sök-API är ett gränssnitt som erbjuder externa system läsåtkomst till information i SDK Adressbok.
Teknisk guide Adressbok API är framtaget som stöd för utvecklare vid en del av Regelverk för anslutning till Säker digital kommunikation och framtaget för implementation av integration mot SDK Adressbok från Meddelandetjänst och Meddelandeklient. Guiden förutsätter att målgruppen har kunskap om SDKs övergripande arkitektur och egen implementation av SDKs meddelandelager (Meddelandetjänst) och verksamhetslager (Meddelandeklient).
Denna guide kompletterar existerande API-dokumentation, se https://inera.atlassian.net/wiki/spaces/OISDK/pages/2736193763/Teknisk+guide+SDK+Adressbok+S+k-API#2.2.2-Dokumentation och https://inera.atlassian.net/wiki/spaces/OISDK/pages/2736193763/Teknisk+guide+SDK+Adressbok+S+k-API#2.3.2-Dokumentation. “Dokumentation”. API-dokumentationen genereras från källkod och driftsätts som en del av Adressbokens mjukvara. Detta borgar för att API-dokumentationen är aktuell i förhållande till driftsatt API. Vid ändringar med påverkan på API kommer alltså även den tekniska API-dokumentation att ändras.
SDK Adressbok informationsmodell, se SDK Adressbok - Informationsspecifikation /wiki/spaces/OISDK/pages/2716107264, beskriver vilken information som Sök-API:et hanterar.
...
| Tips |
|---|
Anslutna organisationer har en eller flera administratörskonton för att administrera sina adressuppgifter via adressbokens grafiska gränssnitt (webbklient). Klienten har en öppen del (kräver ej inloggning) genom vilken man kan använda Adressbokens Sök-API, se meny “Sök funktionsadress”. Länk till grafiskt gränssnitt: SDK PROD (Produktionsmiljö): https://sdk.inera.se/addressbook/ SDK Testbädd (QA): https://at-sdk.ipaas.inera.se/addressbook/ SDK Öppen testmiljö för tjänsteleverantörer ( ÖTM): https://otm-sdk.inera.se/addressbook/ |
2.1 Informationsstruktur
Adressbokens Sök-API är en implementation av SDK Adressbok - Informationsspecifikation /wiki/spaces/OISDK/pages/2716107264 som baseras på standarden JSON:API, se https://jsonapi.org/.
...
Adressbokens Sök-API exponerar resurserna “Organizations” “organizations” och “Addresses”“addresses”.
2.2.1 API URL
Miljö | Bas - URL till API |
|---|---|
SDK PROD (Produktionsmiljö) | |
SDK Testbädd (QA) | |
SDK Öppen testmiljö för tjänsteleverantörerÖTM |
...
Miljö | Länk |
|---|---|
SDK PROD (Produktionsmiljö) | |
SDK Testbädd (QA) | |
SDK ÖTM (Öppen testmiljö för tjänsteleverantörer) |
2.3 Adressbok Kodverksregister-API
Kodverkets Sök-API exponerar resurserna “codesystems” och “codesystems/<identifier>/codes”.
2.3.1 API URL
Miljö | Bas - URL till API |
|---|---|
SDK PROD (Produktionsmiljö) | |
SDK Testbädd (QA) | |
SDK ÖTM (Öppen testmiljö för tjänsteleverantörer) |
...
MIljö | Länk |
|---|---|
SDK PROD (Produktionsmiljö) | |
SDK Testbädd (QA) | |
SDK ÖTM (Öppen testmiljö för tjänsteleverantörer) |
3. Rekommendation vid integration och tillämpning av Sök-API
...
Dock kan det finnas behov av att ha information uppläst lokalt för bättre prestanda för att erbjuda användarvänliga funktioner i ett grafiskt gränssnitt, t.ex. “narrowing search”.
Rekommendationen i ett scenario där man utgår från cachad information är att göra ett anrop till adressbokens API från lokal Meddelandetjänst för att kontrollera/uppdatera adresseringsinformation innan meddelandet läggs på utgående Accesspunkt.
3.1 Paginering vid listningsoperationer
...