FS GraphQL API
FS GraphQL API lar deg utveksle data med FS, både for applikasjons- og integrasjonsbehov.
For å få tilgang, se her:
Dersom GraphQL er nytt for deg, anbefaler vi å lese våre GraphQL-veiledere.
Nyttige URLer
FS GraphQL API er tilgjengelig i flere miljø, så pass på at du bruker riktig URL.
Produksjonsmiljø
- API-endepunkt: https://api.fellesstudentsystem.no/graphql/
- GraphiQL
GraphQL-skjema
GraphQL Voyager
Demomiljø
Merk at dette miljøet inneholder kopi av produksjonsdata og bør derfor brukes med varsomhet.
- API-endepunkt: https://api-test.fellesstudentsystem.no/graphql/
- GraphiQL
GraphQL-skjema
GraphQL Voyager
Testmiljø
Dette miljøet inneholder bare syntetiske (eller åpne) data.
- API-endepunkt: https://api-test.fsweb.no/graphql
- GraphiQL
Enn så lenge har vi ikke tilgjengeliggjort Voyager for dette miljøet.
Vi har valgt å eksponere et midlertidig endepunkt i påvente av at endelig adresse kommer på plass. Så snart dette skjer vil vi selvsagt varsle overgang og støtte begge endepunkter i tre måneder fra varslingen.
GraphQL-skjema
GraphQL Voyager
Vi har ikke satt opp GraphQL Voyager for dette miljøet enda. Siden skjemaene for test-, demo- og produksjonsmiljøene normalt sett er identiske så anbefaler vi at dere bruker Voyager fra demo-miljøet.
Tidlig tilgang til funksjonalitet under utvikling
Vi gir tidlig tilgang til funksjonalitet som er under utvikling, både i test- og produksjonsmiljøet.
For å unngå at noen tar i bruk uferdig funksjonalitet ved et uhell, er slik funksjonalitet opt-in.
Det vil si at må sette Feature-Flags-headeren for å få med de delene av APIet som ikke er stabile.
Verdien for headeren skal være en kommaseparert liste av stabilitetsnivå man aksepterer.
I API-kontrakten skiller vi mellom stabilt, beta- og eksperimentelt nivå. Kunder som er med og tester, vil i så fall få beskjed direkte om verdien headeren skal inneholde.
| Tilgang til | Header |
|---|---|
| Stabil | |
| Stabil og beta | Feature-Flags: beta |
| Stabil, beta og eksperimentell | Feature-Flags: beta,experimental |
Hvis du ønsker eksperimentell funksjonalitet, skal du alltid angi både beta og experimental i headeren. Dette er for å unngå at
spørringen din brekker hvis felter blir flyttet til beta uten at du er klar over det.
I Voyager kan du sette headerne med URL-parameteren ?flags.
I GraphiQL setter du headeren direkte i grensesnittet.
Headeren må være JSON-formatert, slik:
{ "Feature-Flags": "beta,experimental" }
Endringslogg
Nyttige ressurser
Følgende kan være nyttige ressurser for å forstå hvordan man jobber med GraphQL: