🔒 API-adgang er ikke tilgængelig på alle pakker. Kontakt support@famly.co for at tjekke, om du bør have adgang
Denne artikel forklarer, hvilke API’er der er tilgængelige i Famly, hvordan du genererer en adgangstoken, og hvad du bør overveje, når du bygger integrationer.
Tilgængelige API’er
Famly tilbyder både et Public API og et Internal API.
Public API
Dokumentation: https://docs.famly.co/
GraphQL-endpoint: https://famlyapi.famly.co/v1/graphql
Internal API
GraphQL-endpoints
REST-endpoints
Sådan får du en adgangstoken
Nedenfor finder du instruktioner til, hvordan du får en adgangstoken, som kan bruges enten til ét enkelt site eller til hele din organisation, når du arbejder med API’erne.
Vigtigt at vide om API-tokens
Tjek altid tokenets udløbsdato
Du modtager en påmindelse syv dage før tokenet udløber
Giv kun de absolut nødvendige tilladelser
Adgangstokens fungerer både til Public API og Internal API
💡 Del aldrig adgangstokens via usikre kanaler som e-mail eller chat.
Organisationstoken
Sådan opretter du et token på organisationsniveau:
Gå til Home
Vælg organisationen i Site picker
Klik på Settings
Klik på Show under Manage API tokens
Tilføj et nyt token
Sitetoken
Sådan opretter du et token på siteniveau:
Gå til Settings
Klik på Integrations
Klik på Manage API tokens
Tilføj et nyt token
Public API
Public API er den foretrukne løsning, når du bygger integrationer med Famly.
Hvis du ikke kan finde de data, du har brug for der, kan du overveje at bruge Internal API i stedet.
Hvad er Internal API
Famlys Internal API er det, selve appen bruger til at kommunikere med backend. Det består af:
Et GraphQL-API, som minder om Public API, men indeholder væsentligt flere felter og endpoints
Et REST-API
Da frontend er afhængig af det, er alt, der er synligt i appen, teknisk set tilgængeligt via dette API.
Sådan finder du dataflows
Den bedste måde at forstå dataflows på er at åbne netværksinspektøren i din browser.
Udfør de handlinger, du vil genskabe i din integration, via Famly-grænsefladen
Observer hvilke netværkskald der sendes, og hvor de går hen
På den måde kan du se:
Parametre sendt til backend
Svar returneret til frontend
Værktøjer der gør arbejdet lettere
Vi anbefaler kraftigt at bruge Postman til at bygge og teste dine API-kald.
Det giver dig:
Værktøjer til REST-forespørgsler
Værktøjer til GraphQL-forespørgsler
Mulighed for nem test og fejlfinding
Adgang
Der findes ingen separate adgangsbegrænsninger for API’erne.
De API-nøgler, du genererer, fungerer allerede til både Public API og Internal API
Adgang gives eller begrænses ikke teknisk af Famly
Begrænsninger og vilkår du skal forstå
Før du integrerer med Famlys Internal API’er, skal du udtrykkeligt acceptere følgende:
Ingen support
Famly yder ikke support til integrationer bygget mod Internal API
Hvis noget går i stykker, kan Famly ikke forventes at hjælpe med at diagnosticere eller løse problemet
Ingen garanti for bagudkompatibilitet
Public API garanterer bagudkompatibilitet
Internal API kan indeholde ændringer, der bryder eksisterende integrationer
Disse ændringer kan ske uden varsel
Ingen dokumentationssupport
Der findes ingen officiel kundedokumentation for Internal API
Du skal selv identificere endpoints ved at inspicere netværkstrafik fra appen
‼️ Du bygger helt på eget ansvar