Gå til hovedinnhold

API-tilgang

Skrevet av Josie
Oppdatert for over 2 uker siden

🔒 API-tilgang er ikke tilgjengelig på alle pakker. Kontakt support@famly.co for å sjekke om du skal ha tilgang

Denne artikkelen forklarer hvilke API-er som er tilgjengelige i Famly, hvordan du genererer en tilgangstoken, og hva du bør vurdere når du bygger integrasjoner.

Tilgjengelige API-er

Famly tilbyr både et Public API og et Internal API.

Public API

Dokumentasjon er tilgjengelig her: https://docs.famly.co/

GraphQL-endepunkt: https://famlyapi.famly.co/v1/graphql

Internal API

GraphQL-endepunkter

REST-endepunkter

Skaffe en tilgangstoken

Nedenfor finner du instruksjoner for hvordan du kan få en tilgangstoken som kan brukes enten for ett enkelt sted eller for hele organisasjonen din når du arbeider med API-ene.

Noen ting å merke seg om API-tokens:

  • Kontroller alltid utløpsdatoen for tokenet
    Du vil motta en påminnelse syv dager før tokenet utløper

  • Gi kun de absolutt nødvendige tillatelsene

  • Tilgangstokener fungerer både for Public API og Internal API

💡 Del aldri tilgangstokener via usikre kanaler som e-post eller chat.

Organisasjonstilgangstoken

For å opprette et token på organisasjonsnivå:

  1. Gå til Home

  2. Velg organisasjonen i Site picker

  3. Klikk Settings

  4. Klikk Show under Manage API tokens

  5. Legg til et nytt token

Stedstilgangstoken

For å opprette et token på stedsnivå:

  1. Gå til Settings

  2. Klikk Integrations

  3. Klikk Manage API tokens

  4. Legg til et nytt token

Public API

Public API er det foretrukne alternativet når du bygger integrasjoner med Famly. I noen tilfeller kan det hende du ikke finner dataene du trenger der. Hvis det skjer, kan du vurdere å bruke Internal API i stedet.

Hva er Internal API

Famlys Internal API er det selve Famly-appen bruker for å kommunisere med backend. Det består av to deler:

  • Et GraphQL-API, som ligner Public API, men inneholder betydelig flere felt og endepunkter

  • Et REST-API

Fordi frontend er avhengig av det, er alt som er synlig i appen teknisk tilgjengelig gjennom dette API-et.

Finne dataflytene

Den beste måten å forstå dataflytene på er å åpne nettverksinspektøren i nettleseren din. Deretter kan du utføre handlingene du ønsker å gjenskape i integrasjonen din gjennom Famly-grensesnittet og observere hvilke nettverksforespørsler som sendes og hvor de går.

Ved å bruke denne metoden kan du se både parametrene som sendes til backend og svarene som returneres til frontend.

Verktøy som gjør arbeidet enklere

Vi anbefaler sterkt å bruke Postman for å bygge og teste API-kallene dine. Det inkluderer mange nyttige verktøy for både REST- og GraphQL-arbeidsflyter.

Tilgang

Det finnes ingen separate tilgangsbegrensninger for API-ene. API-nøklene du genererer fungerer allerede for både Public API og Internal API. Tilgang er ikke noe Famly formelt gir eller begrenser på et teknisk nivå.

Begrensninger og vilkår du må forstå

Før du integrerer med Famlys Internal API-er, må du uttrykkelig erkjenne følgende:

  1. Ingen støtte gis
    Famly gir ikke støtte for integrasjoner bygget mot Internal API. Hvis noe slutter å fungere, kan det ikke forventes at Famly hjelper med å diagnostisere eller løse problemet.

  2. Ingen garanti for bakoverkompatibilitet
    I motsetning til Public API, hvor bakoverkompatibilitet er garantert, kan Internal API inneholde brytende endringer når deler av appen refaktoreres. Disse endringene kan skje uten forvarsel.

  3. Ingen dokumentasjonsstøtte
    Det finnes ingen kuratert, kundevendt dokumentasjon for Internal API. Du må selv identifisere endepunkter ved å inspisere nettverkstrafikk fra Famly-appen.

‼️ Du bygger helt på eget ansvar

Svarte dette på spørsmålet?