Page History
...
| Reference | Beskrivelse |
|---|---|
CMS | Content Management System |
GM | Graviditetsmappen |
BFF | Backend for frontend |
Adgang, brug og snitflader
Adgang
<Beskrivelse af hvordan service/komponent bruges, snitflade(r), endpoints, og andet relevant>
| Tilgængelig | <Angiv på hvilke(n) NSP-installation(er) servicen/komponenten er tilgængelig> |
| Endpoint(s) | <Angiv udstillede endpoint(s), og hvad de hedder.> |
| WSDL | <Angiv henvisning til WSDL(er). For ekstern anvendbare services typisk på https://wsdl.nspop.dk/> |
| Beskrivelse af services | <Beskrivelser af service(s) / actions på endpoint(s). I lægmands termer beskrive hvad man kan forvente af de enkelte services.> |
| Namespaces etc | <Angiv eventuelt Namespaces, eksterne typer, ..> |
Brugertyper (roller)
I Strapi administrationpanelet arbejdes der med følgende brugertyper:
- Systemadministrator: En bruger med overordnede rettigheder, der administrerer systemindstillinger og brugeradgange.
- Redaktør: En administrator, der har ansvar for indholdsoprettelse og -vedligeholdelse i administrationsportalen.
- Redaktør med brugeroprettelsesrettigheder: En administrator, der har ansvar for indholdsoprettelse og -vedligeholdelse i administrationsportalen, samt oprettelse og administration af brugere.
Snitfladebeskrivelse og brug
Følgende bekriver Strapi og Meilisearch snitfladerne.
Strapi snitflade
Strapi CMS'en udstiller en række endpoints til at hente de definerede indholdstyper. Alle API-endpoints er offentligt tilgængelige, hvilket betyder, at det ikke er nødvendigt at sætte en authentication header på anmodningerne.
Indholdstyper
Jf. use cases skal følgende indholdstyper konfigureres i GM-CMS.
Indholdstype | Beskrivelse | Relation | id |
Kategori | Indeholder titel og tilhørende artikler | Kategori “tilhører flere” artikler | category |
Artikel | Indeholder titel, beskrivelse, tags, boolean til angivelse af om artikel skal skjules på forside, samt tilhørende kategorier og sektioner | Kategori ”har flere” artikler Artikel “tilhører flere” sektioner | article |
Sektion | Indeholder titel, tekst, liste af ugenumre i graviditet/efter fødsel hvor sektionen er relevant, samt tilhørende artikler | Artikel “har flere” sektioner | section |
Tjekliste | Indeholder titel, beskrivelse, samt tilhørende tjektlistepunkter | Tjekliste ”tilhører flere” tjeklistepunkter | checklist |
Tjeklistepunkt | Indeholder titel, beskrivelse, samt tilhørende tjektliste | Tjekliste “har flere” tjeklistepunkter | checklist-point |
Ordforklaring | Indeholder ord og ordforklaring | glossary-term | |
Tekst | Indeholder titel, tekst, beskrivelse og unikt API-navn. Bruges til at oprette tekster om samtykkeerklæring, databeskyttelse osv. | text | |
FAQ | Indeholder spørgsmål og svar | faq |
Strapi endpoints
Indholdstype | Endpoirt |
Kategori | /api/categories |
Artikel | /api/articles |
Sektion | /api/sections |
Tjekliste | /api/checklists |
Tjeklistepunkt | /api/checklist-points |
Ordforklaring | /api/glossary-terms |
Tekst | /api/texts |
FAQ | /api/faqs |
...
Eksempelvis for at få alle artikler, samt relaterede kategorier og sektioner kaldes:
| /api/articles?populate=* |
|---|
Eksempler på Strapi request/responses
Herunder ses eksempler på Strapi request/responses der foretages af GM-BFF:
| Type | Request | Beskrivelse | Respons | ||
|---|---|---|---|---|---|
| GET | /api/checklists&populate=* | Returnerer indholdstype samt alle relationer. |
| ||
| GET | api/articles?filters[Sektioner][UgenummreEfterFoedsel][$contains]={UGENUMMER_EFTER_FOEDSEL}&populate=* | Returnerer alle sektioner (inkl. tilhørende artikler og kategorier) hvor parameter UGENUMMER_EFTER_FOEDSEL er i listen UgenummreEfterFoedsel. Anvendes til at finde relevante artikler til borger med angivet fødselsdato. |
| ||
| GET | api/articles?filters[Sektioner][UgenumreUnderGraviditet][$contains]={UGENUMMER_UNDER_GRAVIDITET}&populate=* | Returnerer alle sektioner (inkl. tilhørende artikler og kategorier) hvor parameter UGENUMMER_UNDER_GRAVIDITET er i listenUgenumreUnderGraviditet. Anvendes til at finde relevante artikler til borger med terminsdato. |
| ||
| GET | /api/texts?filters[ApiNavn][$eq]={API_NAVN} | Returnerer indholdstype tekst, hvor ApiNavn er lig parameter API_NAVN. Eksempelvis samtykke-tekst. |
|
Meilisearch snitflade
Meilisearch services anvendes til at søge i de artikler (inklusive sektioner og kategorieR) som CMS'en udstiller. Alle Meilisearch API-endpoints er offentligt tilgængelige.
Søgbare indholdstyper
I Strapi administrationspanelt under Meilisearch (forstørrelsesglas i venstre side) skal følgende bokse tjekkes af for at gøre indholdstyperne søgbare:
...
Herefter kan der søges i indholdstyperne.
Meilisearch endpoints
Indholdstype | Endpoirt |
Category | /indexes/category/search |
Article | /indexes/article/search |
Section | /indexes/section/search |
Eksempler på Meilisearch request/responses
Herunder ses eksempler på Meilisearch request/responses der foretages af GM-BFF:
| Type | Request | Beskrivelse | Respons | ||
|---|---|---|---|---|---|
| GET | /indexes/article/search?q={SEARCH_STRING} | Returnerer fremsøgte artikler (inklusiv relaterede kategorier og sektioner releateret til søgestrengen. |
|
Generelle koder, værdier, etc.
Ikke relevant
Fejlbeskeder
Herunder er nogle af de mest almindelige fejlbeskeder og deres årsager.
...
- Mulige årsager:
- Meilisearch servicen kører ikke eller den forkerte Meilisearch host/port er konfigureret i Strapi
- API key konfigureret i Strapi projekt stemmer ikke overens med API key konfigureret i Meilisearch
- Løsninger:
- Konfigurer .env variable CMS_MEILISEARCH_API_KEY i Strapi til at have samme værdi som værdi for Meilisearch master-key
Test
Ikke relevant.
Dokument Historik
| 3/4 2025 | Martin Henriksen/SDS | Etablering af dokumentation |
| 10/4 2025 | Dikte Straadt/Trifork | Initiel udfyldning af dokumentation |
...