Loading
I den här artikeln kommer du att lära dig hur man konfigurerar och använder systeme.io offentliga API, inklusive hur man genererar API-nycklar och vilka åtgärder du kan utföra.
1. Vad är ett API?
Förkortningen API står för "Application Programming Interface", en serie av instruktioner genom vilka en plattform erbjuder tjänster till andra plattformar. Det är en strategisk gateway för externa utvecklare, vilket gör det möjligt för dem att komma åt specifik funktionalitet eller data från en plattform på ett strukturerat och säkert sätt. Det är som en uppsättning av färdiga verktyg som underlättar skapandet av nya applikationer, tjänster eller kombinationer.
Sammanfattningsvis öppnar systeme.io upp för andra plattformar att erbjuda sina tjänster där det tillför ett mervärde.
2. Hur fungerar vårt offentliga API?
Vårt API exponerar en noggrant utvald uppsättning funktioner, vilket gör det möjligt för utvecklare att interagera med vår plattform på ett tydligt och effektivt sätt. Om du vill veta mer om hur det fungerar, kan du läsa vår officiella API-dokumentation.
3. Hur man genererar dina API-nycklar
API-nycklar är unika identifierare som autentiserar förfrågningar till vårt offentliga API. De gör det möjligt för dig att programmatiskt få tillgång till och hantera olika resurser på vår plattform.
För att skapa en offentlig API-nyckel, klicka på din profilbild, välj Inställningar (1) och scrolla ner till MCP & API-nycklar (2).
Klicka Skapa (3) för att börja skapa en offentlig API-nyckel.
I pop-upen Skapa offentlig API-nyckel, ange ett namn och välj ett utgångsdatum och tid för din API-nyckel.
När du är klar, klicka på Spara (4).
Notera: För att hålla din API-nyckel aktiv på obestämd tid, lämna fältet 'Utgång' tomt.
Din nyckel är nu redo.
4. Vad kan du göra med vårt API?
Vårt API öppnar upp några intressanta möjligheter. Nedan hittar du de huvudsakliga åtgärder du kan utföra med vårt offentliga API:
a. Kontakter, taggar och anpassade fält:
- Hantera kontakter: Skapa nya kontakter, uppdatera befintliga, lista din publik med avancerade filter eller ta bort kontakter.
- Hantera taggar: Skapa, tilldela, lista och ta bort taggar från kontakter.
- Anpassade fält: Hämta tillgängliga kontaktanpassade fält och deras identifierare (slugs) för att korrekt fylla i kontaktinformation.
b. Nyhetsbrev:
- Skapa och uppdatera nyhetsbrev: Skapa nya nyhetsbrevsutkast eller delvis uppdatera befintliga. Du kan definiera redigeringstypen (Klassisk eller Visuell), hämta fullständigt HTML-innehåll och explicit ställa in avsändarens namn och e-postadress.
- Lista och hämta: Bläddra genom dina befintliga nyhetsbrev eller hämta fullständigt innehåll av ett specifikt nyhetsbrev med dess ID.
c. Funnlar och sidredigerare:
- Hantera funnlar: Skapa nya funnlar, lägg till nya steg (sidor) till dem och hämta en lista över alla individuella steg inom en specifik funnel.
- Sidredigerare: Spara genererat sidinnehåll direkt till dina funnelsteg eller webbplatssidor (fullständigt ersätt), och hämta JSON-scheman för specifika sidtyper.
d. Prisplaner och kuponger:
- Skapa, redigera och ta bort: Generera nya prisplaner och kuponger, eller delvis uppdatera och ta bort befintliga.
- Lista och sök: Bläddra igenom alla dina befintliga prisplaner och kuponger, eller hämta specifika objekt genom deras ID.
e. Kurser och studenter:
- Hantera kurser och studenter: Hämta en lista över dina befintliga kurser och få en lista över studenter som för närvarande är inskrivna.
- Skriv in studenter: Programmera inskrivning av kontakter i dina individuella kurser.
Notera om kurser: Stöd för kursbundles kommer att läggas till i framtida uppdateringar.
f. Gemenskaper:
- Hantera gemenskaper: Hämta en lista över dina befintliga gemenskaper och få tillgång till en lista över de nuvarande medlemmarna i en specifik gemenskap.
- Bjud in medlemmar: Programmera inbjudningar av nya användare att gå med i dina gemenskaper genom att ange deras kontakt-ID.
g. Automatiseringsregler:
- Hantera regler: Programmera anslutningen mellan vanliga händelser och åtgärder, uppdatera befintliga regler (t.ex. ändra en åtgärd medan triggereventet förblir detsamma) eller mjukradera regler.
- Lista och hämta: Bläddra bland dina automatiseringsregler eller hämta en specifik regel genom dess ID.
h. Prenumerationer:
- Hantera prenumerationer: Hämta en lista över alla resurser i en prenumeration från tredjepartsplattformar och avsluta en prenumeration antingen omedelbart eller vid slutet av faktureringscykeln.
i. Webhooks
- Hantera webhooks: Programmera skapandet av nya webhooks för att få realtidsnotifikationer, hämta listor över dina befintliga webhooks och ta bort webhooks som inte längre behövs.
Anteckningar:
- För att enkelt identifiera och hantera dina tokens, måste varje ha ett unikt namn.
- En token kan endast kopieras omedelbart efter att den skapats. Om du glömde att kopiera din token, radera den och skapa en ny.
- Som en säkerhetsåtgärd kommer vi skicka en e-postnotifikation när en ny offentlig API-nyckel skapas i ditt systeme.io-konto.
- Du kan skapa upp till 3 API-nycklar per konto.
Lär dig mer: API-dokumentation.