Teknisk dokumentation för gränssnittet för sökning av platsplatsannonser

Syftet med dokumentationen

Denna dokumentation preciserar de tekniska kraven för Jobbmarknadens gränssnitt för sökning av platsannonser och beskriver mer detaljerat hur själva gränssnittet används. Processen för att ta gränssnittet i bruk beskrivs mer ingående på Jobbmarknadens webbplats. På samma plats finns även OpenAPI-beskrivningar för P67-gränssnittet som är kopplat till hantering av platsannonser.

Användningssyfte

Platsannonser på Jobbmarknaden kan sökas on hämtas till externa tjänster genom gränssnittet. Det är möjligt att använda olika filter för att begränsa sökresultaten. Sökresultaten skickas till externa tjänster som utför sökningen i enlighet med platsannonsens struktur.

Införande

Gränssnittet för sökning av platsannonser på Jobbmarknaden tillhandahålls via KEHA-centrets integrationsplattform (Kipa). Användaruppgifter för plattformen samt relaterade IP-öppningar hanteras av KEHA-centret som en del av införandeprocessen. De uppgifter som behövs för att använda gränssnittet levereras säkert till användaren. Mer detaljerad information om införandet finns på Jobbmaknaden webbplats.

Sökning av platsannonser

Detaljerade processer för sökning av platsannonser illustreras i diagrammet nedan.

processer för sökning av platsannonser - beskrivs i texten nedan

Den faktiska sökining av platsannonser sker via tjänsten P67 på Kipa-integrationsplattformen, som kommunicerar med Jobbmarknadens backend-tjänst. Tillgängliga funktioner, datainnehåll och svar beskrivs i YAML-beskrivningen för sökningsgränssnittet.

Sökningen sker med HTTP:s POST-metod, så att de uppdaterade filtren lättare kan inkluderas i anropet och hanteringen av dem blir enklare i båda ändarna av gränssnittet.

Anrop via Kipa-integrationsplattformen auktoriseras med en API-nyckelmekanism, och anropets header-information måste innehålla KIPA-Subscription-Key som tillhandahålls för Kipa-användning.

Endpoint

Tjänsten P66 på Kipa-integrationsplattformen finns på följande adresser:

Sökresultat

Sökresultat som matchar filtren returneras till den externa tjänsten som en Newline-delimited JSON (NDjson) stream.

Koduppsättningar

Olika koduppsättningsvärden relaterade till jobbsökningsprofilen finns tillgängliga från JobbMarknadens-koduppsättningstjänsten. Koduppsättningarna för olika data beskrivs nedan. OpenApi-beskrivningen innehåller också information om koduppsättningen relaterad till attributet.

Koduppsättningens json-struktur läses på ett sådant sätt att kodvärdena kan hittas i id-elementet och beskrivningen relaterad till id:t lokaliserad i description-elementet. Varje kodvärde har också en giltighetsperiod. Koduppsättningen kan därför innehålla kodvärden som redan har tagits ur bruk. I sådana fall har koderna information om utgångsdatum. Vissa koduppsättningar kan ha tillägg som kan användas för att förfina användningen av koduppsättningen. Till exempel används tillägget subset för att begränsa endast vissa kod-ID:n till ett specifikt syfte. Tillägget sekvensnummer anger önskad ordning för koderna, till exempel i urvalslistor.