paw-arbeidssoekerregisteret-api-oppslag

REST-api for oppslag i arbeidssøkerregisteret

Dokumentasjon for API

https://oppslag-arbeidssoekerregisteret.intern.dev.nav.no/docs

Flytdiagram

flowchart RL;
    A(Frontend/backend løsninger);
    subgraph paw-arbeidssoekerregisteret-api-oppslag
        B[TOKENX/AZURE];
        id1[REST API <br/> <br/> GET <br/> /arbeidssoekerperioder <br/> /opplysninger-om-arbeidssoeker <br/> /profilering <br/> <br/> POST <br/> /veileder/arbeidssoekerperioder <br/> /veileder/opplysninger-om-arbeidssoeker <br/> /veileder/profilering];
        id2[Helse endepunkter <br/> Opentelemetry tracing <br/> Logging];
        C[Services];
        D[(Postgres database)];
        E[Consumer: arbeidssøkerperiode];
        F[Consumer: opplysninger-om-arbeidssøker];
        G[Consumer: profilering];
    end;
    H[Kafka topic: arbeidssoekerperiode];
    I[Kafka topic: opplysninger-om-arbeidssoeker];
    J[Kafka topic: arbeidssoeker-profilering];
    A-->B;
    B-->id1;
    id2~~~id1
    C-->id1;
    D-->C
    E-->D
    F-->D;
    G-->D;
    J-->G;
    I-->F;
    H-->E;

Loading

Autentisering

Kall til API-et er autentisert med Bearer token fra TokenX eller Azure. Eksempel: Authorization: Bearer <token>

TOKENX

For oppslag som gjøres av arbeidssoker selv:

• /arbeidssoekerperioder
• /opplysninger-om-arbeidssoeker/{periodeId}
• /profilering/{periodeId}

{ "acr": "Level4", "pid": "<fnr>" }

AZURE:

For oppslag som gjøres av veileder eller system:

• /veileder/arbeidssoekerperioder
• /veileder/opplysninger-om-arbeidssoeker/{periodeId}
• /veileder/profilering/{periodeId}

Token med veileder-ident:

{
  "oid": "989f736f-14db-45dc-b8d1-94d621dbf2bb",
  "NAVident": "<veileder-ident>"
}

• Verifiserer veileders leserettigheter med POAO-tilgang.

Machine-to-maching token:

{
  "oid": "989f736f-14db-45dc-b8d1-94d621dbf2bb",
  "roles": ["access_as_application"]
}

• Krever ikke NAVident i tokenet og brukes kun av systemer.

Teknologier

Øvrige teknologier, rammeverk og biblioteker som er blitt tatt i bruk:

• Kotlin
• Ktor
• PostgreSQL
• Flyway
• Gradle

Dev oppsett

1. Opprett dolly bruker

Gå til https://dolly.ekstern.dev.nav.no/testnorge og imporer en bruker fra test-norge

2. Opprett dolly bruker som arbeidssøker

Gå til https://arbeid.intern.dev.nav.no/arbeid/registrering og registrer bruker.

Vent litt.

3. Logg inn i tokenx-token-generator med test-id med din nye dolly bruker

Gå til https://tokenx-token-generator.intern.dev.nav.no/api/obo?aud=dev-gcp:paw:paw-arbeidssoekerregisteret-api-oppslag

• For /veileder endepunkter.

Logg inn med trygdeetatenbruker på https://azure-token-generator.intern.dev.nav.no/api/obo?aud=dev-gcp:paw:paw-arbeidssoekerregisteret-api-oppslag

4. Gjør kall mot API-et

Bruk access_token i "Token Response" (fra steg 3) til å gjøre forespørsler mot https://oppslag-arbeidssoekerregisteret.intern.dev.nav.no

Eksempel:

$ curl https://oppslag-arbeidssoekerregisteret.intern.dev.nav.no/api/v1/arbeidssoekerperioder -H 'Authorization: Bearer <access_token>'

Lokalt oppsett

Under er det satt opp et par ting som må på plass for at applikasjonen og databasen skal fungere.

JDK 21

JDK 21 må være installert. Enkleste måten å installere riktig versjon av Java er ved å bruke sdkman.

Docker

docker og docker-compose må være installert. For å installere disse kan du følge oppskriften på Dockers offisielle side. For installering på Mac trykk her eller trykk her for Ubuntu.

Man må også installere docker-compose som en separat greie for Ubuntu. For Mac følger dette med når man installerer Docker Desktop.

Kjør opp docker containerne med

docker-compose up -d

Se at alle kjører med

docker ps

Fem containere skal kjøre; kakfa, zookeeper, schema-registry, postgres og mock-oauth2-server.

Gradle properties

Generer et PAT (personal access token) i github her.

Gi tokenet minimum read rettigheter -> kopier tokenet -> Autoriser gjennom navikt.

Legg til denne linjen i gradle.properties:

githubPassword=<github-personal-access-token>

App

Start app med ./gradlew run eller start via intellij

Autentisering

For å kalle APIet lokalt må man være autentisert med et Bearer token.

Vi benytter mock-oauth2-server til å utstede tokens på lokal maskin. Følgende steg kan benyttes til å generere opp et token:

1. Sørg for at containeren for mock-oauth2-server kjører lokalt (docker-compose up -d)
2. Naviger til mock-oauth2-server sin side for debugging av tokens
3. Generer et token
4. Trykk på knappen Get a token
5. Skriv inn noe random i "Enter any user/subject" og pid i optional claims, f.eks.

{ "acr": "Level4", "pid": "18908396568" }

For veileder:

{
  "oid": "989f736f-14db-45dc-b8d1-94d621dbf2bb",
  "NAVident": "test"
}

For veileder med system-token: Hvis du skal teste verifisering av tilgang for NavIdent, kan du legge til Nav-Ident i header på request.

{
  "oid": "989f736f-14db-45dc-b8d1-94d621dbf2bb",
  "roles": ["access_as_application"]
}

6. Trykk Sign in

7. Kopier verdien for access_token og benytt denne som Bearer i Authorization-header

8. Eksempel:

$ curl localhost:8080/api/v1/arbeidssoekerperioder -H 'Authorization: Bearer <access_token>'

eller benytt en REST-klient (f.eks. insomnia eller Postman)

Kafka

Kafka UI ligger i docker-compose, og finnes på http://localhost:9000

Produser kafkameldinger for lokal utvikling

Kjør ./gradlew produceLocalMessagesForTopics

Denne tasken sender to meldinger til arbeidssokerperioder-v1, en melding til opplysninger-om-arbeidssoeker-v1 og en melding til arbeidssoker-profilering-v1.

Consumer

Konsumer meldinger fra arbeidssokerperioder-v1

docker exec -it paw-arbeidssoekerregisteret-api-oppslag_kafka_1 /usr/bin/kafka-console-consumer --bootstrap-server 127.0.0.1:9092 --topic arbeidssokerperioder-v1

Konsumer meldinger fra opplysninger-om-arbeidssoeker-v1

docker exec -it paw-arbeidssoekerregisteret-api-oppslag_kafka_1 /usr/bin/kafka-console-consumer --bootstrap-server 127.0.0.1:9092 --topic opplysninger-om-arbeidssoeker-v1

Konsumer meldinger fra arbeidssoker-profilering-v1

docker exec -it paw-arbeidssoekerregisteret-api-oppslag_kafka_1 /usr/bin/kafka-console-consumer --bootstrap-server 127.0.0.1:9092 --topic arbeidssoker-profilering-v1

Deploye kun til dev

Ved å prefikse branch-navn med dev/, så vil branchen kun deployes i dev.

git checkout -b dev/<navn på branch>

evt. rename branch

git checkout <opprinnlig-branch>
git branch -m dev/<opprinnlig-branch>

Henvendelser

Spørsmål knyttet til koden eller prosjektet kan stilles via issues her på github.

For NAV-ansatte

Interne henvendelser kan sendes via Slack i kanalen #team-paw-dev

Lisens

MIT