Hvordan bruke systeme.io offentlig API (Application Programming Interface)

I denne artikkelen vil du lære hvordan du konfigurerer og bruker systeme.io offentlig API, inkludert hvordan du genererer API-nøkler og hvilke handlinger du kan utføre.

1. Hva er et API?

Forkortelsen API står for "Application Programming Interface", en serie av instruksjoner som en plattform bruker for å tilby tjenester til andre plattformer. Det er en strategisk inngangsport for eksterne utviklere, som gjør det mulig for dem å få tilgang til spesifikke funksjoner eller data fra en plattform på en strukturert og sikker måte. Det er som et sett med ferdige verktøy som gjør det enkelt å bygge nye applikasjoner, tjenester eller kombinasjoner.

Kort sagt, systeme.io åpner opp for andre plattformer for å tilby sine tjenester der det har merverdi.

2. Hvordan fungerer vårt offentlige API?

Vårt API gir tilgang til en nøye utvalgt rekke funksjoner, slik at utviklere kan samhandle med plattformen vår på en åpen og effektiv måte. Hvis du vil vite mer om hvordan det fungerer, kan du lese vår offisielle API-dokumentasjon.

3. Hvordan generere dine API-nøkler

API-nøkler er unike identifikatorer som autentiserer forespørsler til vårt offentlige API. De gjør det mulig for deg å programmatisk få tilgang til og administrere ulike ressurser på plattformen vår.

For å opprette en offentlig API-nøkkel, klikk på profilbildet ditt, velg Innstillinger (1), og bla ned til MCP & API-nøkler (2).

Klikk på Opprett (3) for å begynne å opprette en offentlig API-nøkkel.

I popup-vinduet Opprett offentlig API-nøkkel skriver du inn et navn og velger en utløpsdato og -tid for API-nøkkelen din.

Når du er ferdig, klikk Lagre (4).

Merk: For å holde API-nøkkelen aktiv på ubestemt tid, la "Utløp"-feltet stå tomt.

Nøkkelen din er nå klar.

4. Hva kan du gjøre med vårt API?

Vårt API åpner for noen interessante muligheter. Nedenfor finner du hovedhandlingene du kan utføre ved hjelp av vårt offentlige API:

a. Kontakter, tagger og tilpassede felt:

• Administrer kontakter: Opprett nye kontakter, oppdater eksisterende, list opp publikum med avanserte filtre, eller slett kontakter.
• Administrer tagger: Opprett, tilordne, list og fjern tagger fra kontakter.
• Tilpassede felt: Hent tilgjengelige kontaktfelt og deres identifikatorer (slugs) for å fylle ut kontaktinformasjon korrekt.

b. Nyhetsbrev:

• Opprett og oppdater nyhetsbrev: Opprett nye nyhetsbrevdokument, eller delvis oppdater eksisterende. Du kan definere redaktørtypen (Klassisk eller Visuell), hente det fullstendige HTML-innholdet, og eksplisitt angi avsenderens navn og e-postadresse.
• List og hent: Bla gjennom dine eksisterende nyhetsbrev eller hent det fullstendige innholdet av et spesifikt nyhetsbrev ved å bruke dets ID.

c. Trakter og sideeditor:

• Administrer trakter: Opprett nye trakter, legg til nye trinn (sider) i dem, og hent en liste over alle individuelle trinn innenfor en spesifikk trakt.
• Sideeditor: Lagre generert sideinnhold direkte til dine trakttrinn eller nettsider (full erstatning), og hent JSON-skjemaer for spesifikke sidetyper.

d. Prispakker og kuponger:

• Opprett, rediger, og slett: Generer nye prispakker og kuponger, eller delvis oppdater og slett eksisterende.
• List og søk: Bla gjennom alle dine eksisterende prispakker og kuponger, eller hent spesifikke elementer ved hjelp av deres ID.

e. Kurs og studenter:

• Administrer kurs og studenter: Hent en liste over dine eksisterende kurs og hent en liste over studenter som for tiden er påmeldt.
• Meld inn studenter: Programmatisk melde på kontakter i dine individuelle kurs.

Merk om kurs: Støtte for kurspakker vil bli lagt til i fremtidige oppdateringer.

f. Fellesskap:

• Administrer fellesskap: Hent en liste over dine eksisterende fellesskap og få tilgang til en liste over nåværende medlemmer innen et spesifikt fellesskap.
• Inviter medlemmer: Programmatisk invitere nye brukere til å bli med i dine fellesskap ved å oppgi deres kontakt-ID.

g. Automatiseringsregler:

• Administrer regler: Programmatisk knytte vanlige hendelser og handlinger, oppdatere eksisterende regler (f.eks. endre en handling mens du beholder utløseren den samme), eller myke-slette regler.
• List og hent: Bla gjennom dine automatiseringsregler eller hent en spesifikk regel ved dens ID.

h. Abonnementer:

• Administrer abonnementer: Hent en liste over alle ressurser i et abonnement fra tredjepartsplattformene, og kanseller et abonnement enten umiddelbart eller ved slutten av faktureringssyklusen.

i. Webhooks

• Administrer webhooks: Programmatisk opprette nye webhooks for å motta sanntidsvarsler, hente lister over dine eksisterende webhooks, og fjerne webhooks som ikke lenger er nødvendige.

Merknader:

• For å enkelt kunne identifisere og administrere dine tokens, må hver ha et unikt navn.
• Et token kan bare kopieres umiddelbart etter at det er opprettet. Hvis du har glemt å kopiere tokenet ditt, slett det og opprett et nytt.
• Som et sikkerhetstiltak vil vi sende deg et e-postvarsel hver gang en ny offentlig API-nøkkel opprettes i din systeme.io-konto.
• Du kan opprette opptil 3 API-nøkler per konto.

Lær mer: API-dokumentasjon.