Sådan bruger du systeme.io offentlige API (Application Programming Interface)

I denne artikel vil du lære, hvordan du konfigurerer og bruger systeme.io offentlige API, inklusive hvordan du genererer API-nøgler, og hvilke handlinger du kan udføre.

1. Hvad er en API?

Forkortelsen API står for "Application Programming Interface", en række instruktioner, hvorved en platform tilbyder tjenester til andre platforme. Det er en strategisk gateway for eksterne udviklere, der gør det muligt for dem at få adgang til specifik funktionalitet eller data fra en platform på en struktureret, sikker måde. Det er som et sæt værktøjer, der er klar til brug, hvilket gør det nemt at bygge nye applikationer, tjenester eller kombinationer.

Kort sagt, systeme.io åbner op for andre platforme for at tilbyde sine tjenester, hvor det har tilføjet værdi.

2. Hvordan fungerer vores offentlige API?

Vores API udstiller et nøje udvalgt sæt funktioner, der gør det muligt for udviklere at interagere med vores platform på en gennemsigtig og effektiv måde. Hvis du vil vide mere om, hvordan det fungerer, kan du læse vores officielle API-dokumentation.

3. Sådan genererer du dine API-nøgler

API-nøgler er unikke identifikatorer, der autentificerer forespørgsler til vores Public API. De giver dig mulighed for programmæssigt at få adgang til og administrere forskellige ressourcer på vores platform.

For at oprette en offentlig API-nøgle skal du klikke på dit profilbillede, vælge Indstillinger (1) og scrolle ned til MCP & API-nøgler (2).

Klik på Opret (3) for at begynde at oprette en offentlig API-nøgle.

I pop-up-vinduet Opret offentlig API-nøgle, indtast et navn, og vælg en udløbsdato og -tid for din API-nøgle.

Når dette er gjort, klik på Gem (4).

Din nøgle er nu klar.

4. Hvad kan du gøre med vores API?

Vores API åbner op for nogle interessante muligheder. Nedenfor finder du de vigtigste handlinger, du kan udføre ved hjælp af vores offentlige API:

a. Kontakter, tags og brugerdefinerede felter:

• Administrer kontakter: Opret nye kontakter, opdater eksisterende, list dit publikum med avancerede filtre eller slet kontakter.
• Administrer tags: Opret, tildel, list og fjern tags fra kontakter.
• Brugerdefinerede felter: Hent tilgængelige brugerdefinerede kontaktfelter og deres identifikatorer (slugs) for at udfylde kontaktoplysninger korrekt.

b. Nyhedsbreve:

• Opret og opdater nyhedsbreve: Opret nye nyhedsbrevudkast eller opdater eksisterende delvist. Du kan definere redaktørtypen (Klassisk eller Visuel), hente fuld HTML-indhold, og eksplicit sætte afsenderens navn og e-mailadresse.
• List og hent: Gennemse dine eksisterende nyhedsbreve eller hent det fulde indhold af et specifikt nyhedsbrev ved hjælp af dets ID.

c. Sælgtragte og sideeditor:

• Administrer tragte: Opret nye tragte, tilføj nye trin (sider) til dem, og hent en liste over alle individuelle trin inden for en specifik tragt.
• Sideeditor: Gem genereret sideindhold direkte til dine tragttrin eller webstedssider (fuld erstatning), og hent JSON-skemaer for specifikke sidetyper.

d. Prisplaner og kuponer:

• Opret, rediger og slet: Generer nye prisplaner og kuponer, eller opdater eksisterende delvist og slet dem.
• List og søg: Gennemse alle dine eksisterende prisplaner og kuponer, eller hent specifikke genstande med deres ID.

e. Kurser og studerende:

• Administrer kurser og studerende: Hent en liste over dine eksisterende kurser og hent en liste over studerende, der i øjeblikket er indskrevet.
• Indskriv studerende: Programmæssigt indskriv kontakter i dine individuelle kurser.

f. Fællesskaber:

• Administrer fællesskaber: Hent en liste over dine eksisterende fællesskaber og få adgang til en liste over de nuværende medlemmer inden for et specifikt fællesskab.
• Inviter medlemmer: Programmæssigt invitere nye brugere til at slutte sig til dine fællesskaber ved at give deres kontakt-ID.

g. Automatiseringsregler:

• Administrer regler: Programmæssigt forbinde almindelige begivenheder og handlinger, opdatere eksisterende regler (fx ændre en handling, mens udløseren forbliver den samme), eller blødt slette regler.
• List og hent: Gennemse dine automatiseringsregler eller hente en specifik regel ved dens ID.

h. Abonnementer:

• Administrer abonnementer: Hent en liste over alle ressourcer i et abonnement fra tredjepartsplatforme, og annullere et abonnement enten med det samme eller ved slutningen af faktureringscyklusen.

i. Webhooks

• Administrer webhooks: Programmæssigt oprette nye webhooks for at modtage realtidsbeskeder, hente lister over dine eksisterende webhooks og fjerne webhooks, der ikke længere er nødvendige.

Lær mere: API documentation.