Was ist der Unterschied zwischen den API Funktionen „subscribe“ und „singin“?

Die KlickTipp API bietet zwei Funktionen zum Hinzufügen von Abonnenten in die ContactCloud: subscribe und signin. Beide haben unterschiedliche Anwendungsfälle und Authentifizierungsmethoden.

Funktion subscribe:

  • Verwendung: Manuelles Eintragen eines neuen Abonnenten in die ContactCloud.
  • Authentifizierung: Erfordert Benutzername und Passwort.
  • Parameter:
    • email_address: E-Mail-Adresse des Empfängers.
    • list_id (optional): ID des Double-Opt-in-Prozesses.
    • tag_id (optional): ID des Tags für die Kennzeichnung.
    • fields (optional): Zusätzliche Daten des Empfängers.
    • smsnumber (optional): SMS-Mobilnummer des Empfängers.
  • Rückgabe: Objekt mit Daten des Empfängers.
  • Anwendungsbereich: Geeignet für manuelle Anmeldungen durch den Administrator oder interne Prozesse.

Funktion signin:

  • Verwendung: Eintragen eines neuen Abonnenten mit einem API-Key.
  • Authentifizierung: Erfordert einen API-Key.
  • Parameter:
    • api_key: Der API-Key.
    • email_address: E-Mail-Adresse des Empfängers.
    • fields (optional): Zusätzliche Daten des Empfängers.
    • smsnumber (optional): SMS-Mobilnummer des Empfängers.
  • Rückgabe: URL der Bestätigungsseite des Double-Opt-in-Prozesses.
  • Anwendungsbereich: Ideal für automatisierte Prozesse oder Integrationen über externe Anwendungen oder Webseiten.

Zusammenfassung:

  • Die subscribe-Funktion ist für manuelle Eingriffe gedacht, bei denen Nutzer direkt über die KlickTipp-Plattform eingetragen werden.
  • Die signin-Funktion ist für automatisierte Prozesse ausgelegt und nutzt einen API-Key, häufig für Abonnenten, die durch externe Systeme oder über Webformulare hinzugefügt werden.
  • Beide Funktionen dienen dem Hinzufügen von Abonnenten zur ContactCloud, unterscheiden sich jedoch in der Authentifizierung und im Umgang mit dem Double-Opt-in-Prozess.