Startseite>PHP-Quellcode>Andere Kategorien
Herunterladen

Smart Emailing API v3

API-Wrapper für die Smart-E-Mail-API.

  • Installation
  • Verwendung
  • Unterstützt
  • Erweiterte Dokumente
  • Beitrag oder Überschreibung
  • Upgrade
  • Urheberrecht und Lizenz
  • Intelligente E-Mail-API

Installation

Anforderungen

Dieses Paket erfordert PHP 7.4 und höher.

Über Composer installieren 

 composer require pion/smart-emailing-v3

Verwendung

Erstellen Sie eine API-Instanz mit Ihrem Benutzernamen und apiKey. 

 use SmartEmailing  v3  Api ;

. . .
$ api = new Api ( ' username ' , ' api-key ' );

Verwenden Sie dann $api mit der gewünschten Methode/Komponente. 

 // Creates a new instance
$ api -> importRequest ()-> addContact ( new Contact ( ' [email protected] ' ))-> send ();

oder 

 // Creates a new instance
$ import = $ api -> importRequest ();
$ contact = new Contact ( ' [email protected] ' );
$ contact -> setName ( ' Martin ' )-> setNameDay ( ' 2017-12-11 11:11:11 ' );
$ import -> addContact ( $ contact );

// Create new contact that will be inserted in the contact list
$ contact2 = $ import -> newContact ( ' [email protected] ' );
$ contact2 -> setName ( ' Test ' );

// Create new contact that will be inserted in the contact list
$ import -> newContact ( ' [email protected] ' )-> setName ( ' Test ' );
$ import -> send ();

Fehlerbehandlung

Beim Senden einer Anfrage können Sie die Fehlerausnahme RequestException abfangen. 

 use SmartEmailing  v3  Exceptions  RequestException ;

try {
    $ api -> ping ();
} catch ( RequestException $ exception ) {
    $ exception -> response (); // to get the real response, will hold status and message (also data if provided)
    $ exception -> request (); // Can be null if the request was 200/201 but API returned error status text
}

Unterstützt

  • Kontakte importieren
  • Bestellungen importieren
  • Klingeln
  • Anmeldeinformationen
  • Kontaktliste
  • Benutzerdefinierte Felder
    • Benutzerdefinierte Felder – erstellen
    • Benutzerdefinierte Felder – Suche / Liste
    • Benutzerdefinierte Felder - Rest
    • Benutzerdefinierte Felder – Optionen
  • Kontakte
  • Kontakte in der Liste
  • Benutzerdefinierte E-Mails
  • E-Mails
  • Newsletter
  • Webhooks
  • (VERALTET) E-Shops

Erweiterte Dokumente

Kontakte importieren

Der Import enthält zwei Hauptdatenpunkte:

  1. Einstellungen $import->settings()->setUpdate(true)
  2. Kontakte $import->newContact() : Contact , $import->contacts() : array und $import->addContact($contact) : self

Ein Anwendungsbeispiel finden Sie oben.

Kontakt

Der Import enthält 3 Hauptdatenpunkte:

  1. Alle Daten sind über öffentliche Eigenschaften zugänglich. Die Fluent-Set-Methode verfügt über eine grundlegende Validierungs- und Datumskonvertierungslogik
  2. CustomFields $contact->customFields() zum Hinzufügen neuer Felder
  3. ContactLists $contact->contactLists() zum Hinzufügen einer neuen Kontaktliste

Alle Methoden/Eigenschaften, die Sie verwenden können, finden Sie im Quellcode

CustomFields und ContactLists

Verwendet einen Datenbehälter mit den Methoden create / add / get / isEmpty / toArray / jsonSerialize . 

 $ field = $ contact -> customFields ()-> create ( 12 , ' test ' )
$ list = $ contact -> contactLists ()-> create ( 12 , ' confirmed ' )

Bestellungen importieren

Der Import enthält zwei Hauptdatenpunkte:

  1. Einstellungen $import->settings()->setSkipInvalidOrders(true)
  2. Bestellungen $import->newOrder() : Order , $import->orders() : array und $import->addOrder($order) : self

Ein Anwendungsbeispiel finden Sie oben.

BenutzerdefinierteFelder

„customFields“ verwendet einen Wrapper für jede Anfrage im Zusammenhang mit benutzerdefinierten Feldern. Um eine neue Instanz zu erstellen, rufen Sie $api->customFields() auf. Auf diesem Objekt können Sie jede Anfrage erstellen, die aktuell implementiert ist. Siehe unten.

Erstellen

Schnelle Möglichkeit, eine Anfrage mit dem erforderlichen benutzerdefinierten Feld zu erstellen 

 use SmartEmailing  v3  Models  CustomFieldDefinition ;

. . .
// Create the new customField and send the request now.
$ customField = new CustomFieldDefinition ( ' test ' , CustomFieldDefinition:: TEXT );
$ data = $ api -> customFields ()-> create ( $ customField );

 // Get the customField in data
$ customFieldId = $ data -> id ;

oder 

 $ request = $ api -> customFields ()-> createRequest (); // You can pass the customField object

// Setup customField
$ customField = new CustomField ();
$ request -> setCustomField ( $ customField );

// Setup data
$ customField -> setType (CustomField:: RADIO )-> setName ( ' test ' );

// Send the request
$ response = $ request -> send ();
$ data = $ response -> data ();
$ customFieldId = $ data -> id ;

Suche / Liste

API-DOCS

Ermöglicht die Suche nach benutzerdefinierten Feldern mit Filter-/Sortierungsunterstützung. Die Ergebnisse sind auf 100 pro Seite begrenzt. Die Antwort gibt Metadaten (MetaDataInterface) und ein Array von ModelsCustomFieldDefinition zurück, indem sie $response->data() aufruft.

Antwort

  • data() gibt ein Array ModelsCustomFieldDefinition zurück
  • meta() gibt eine stdClass mit Eigenschaften zurück (definiert in MetaDataInterface )

Erhalten Sie eine Liste ohne erweiterte Suche

Erstellt eine Suchanfrage und richtet nur $page oder $limit ein. Die vollständige Antwort von der API mit customfield_options_url oder 

 $ data = $ api -> customFields ()-> list ();

/** @var SmartEmailingv3ModelsCustomFieldDefinition $customField */
foreach ( $ data as $ customField ) {
    echo $ customField -> id ;
    echo $ customField -> name ;
    echo $ customField -> type ;
}

Erweiterte Suche – Filtern/Sortieren/etc 

 $ request = $ api -> customFields ()-> searchRequest ( 1 );

// Search by name
$ request -> filter ()-> byName ( ' test ' );
$ request -> sortBy ( ' name ' );

// Send the request
$ response = $ request -> send ();
$ data = $ response -> data ();
Anforderungsmethoden
  • Getter erfolgen über öffentliches Eigentum
    • Seite
    • Limit
    • wählen
    • expandieren
    • Sortieren
  • Fluent Setter (mit Validierung) – mehr unten.
  • filter() gibt ein Filter-Setup zurück – mehr unten
expandBy(string : $expand)

Mit diesem Parameter wird die Eigenschaft „customfield_options_url“ durch „customfield_options“ ersetzt, die erweiterte Daten enthält. Siehe Beispiele unten. Weitere Informationen finden Sie unter „/customfield-options“-Endpunkt.

Zulässige Werte: „customfield_options“

select(string : $select)

Durch Kommas getrennte Liste der auszuwählenden Eigenschaften. z.B. „?select=id,name“ Wenn nicht angegeben, werden alle Felder ausgewählt.

Zulässige Werte: „id“, „name“, „type“

sortBy(string : $sort)

Durch Kommas getrennte Liste der Sortierschlüssel von der linken Seite. Stellen Sie jeder Taste für die Abwärtsrichtung ein „-“ voran, z. „?sort=Typ,-Name“

Zulässige Werte: „id“, „name“, „type“

setPage(int : $page)

Legt die aktuelle Seite fest

limit(int : $limit)

Legt die Ergebnisgrenze in einer einzelnen Abfrage fest

Filter()

Ermöglicht das Filtern benutzerdefinierter Felder mit mehreren Filterbedingungen.

  • Getter erfolgen über öffentliches Eigentum
    • Name
    • Typ
    • Ausweis
  • Fluent Setter (mit Validierung)
    • byName($value)
    • byType($value)
    • byId($value)

Rufen Sie Ihren Namen an

Führt eine Suchabfrage mit Namensfilter aus und prüft, ob der angegebene Name in „customFields“ gefunden wird. Gibt false oder CustomFieldsCustomField zurück. Verwendet Sendelogik (löst RequestException aus). 

 // Can throw RequestException - uses send.
if ( $ customField = $ api -> customFields ()-> getByName ( ' name ' )) {
    return $ customField -> id ;
} else {
    throw new Exception ( ' Not found! ' , 404 );
}

Senden / Transaktions-E-Mails

Die Implementierung des API-Aufrufs send/transactional-emails-bulk : https://app.smartemailing.cz/docs/api/v3/index.html#api-Custom_campaigns-Send_transactional_emails

Vollständiges Beispiel für eine Transaktions-E-Mail 

 $ transactionEmail = $ api -> transactionalEmailsRequest ();

$ credentials = new SenderCredentials ();
$ credentials -> setFrom ( ' [email protected] ' );
$ credentials -> setReplyTo ( ' [email protected] ' );
$ credentials -> setSenderName ( ' Jean-Luc Picard ' );

$ recipient = new Recipient ();
$ recipient -> setEmailAddress ( ' [email protected] ' );

$ replace1 = new Replace ();
$ replace1 -> setKey ( ' key1 ' );
$ replace1 -> setContent ( ' content1 ' );

$ replace2 = new Replace ();
$ replace2 -> setKey ( ' key2 ' );
$ replace2 -> setContent ( ' content2 ' );

$ templateVariable = new TemplateVariable ();
$ templateVariable -> setCustomData ([
    ' foo ' => ' bar ' ,
    ' products ' => [
        [ ' name ' => ' prod1 ' , ' desc ' => ' desc1 ' ],
        [ ' name ' => ' prod1 ' , ' desc ' => ' desc2 ' ]
    ]
]);

$ attachment1 = new Attachment ();
$ attachment1 -> setContentType ( ' image/png ' );
$ attachment1 -> setFileName ( ' picture.png ' );
$ attachment1 -> setDataBase64 ( ' data1 ' );

$ attachment2 = new Attachment ();
$ attachment2 -> setContentType ( ' image/gif ' );
$ attachment2 -> setFileName ( ' sun.gif ' );
$ attachment2 -> setDataBase64 ( ' data2 ' );

$ task = new Task ();
$ task -> setRecipient ( $ recipient );
$ task -> addReplace ( $ replace1 );
$ task -> addReplace ( $ replace2 );
$ task -> setTemplateVariables ( $ templateVariable );
$ task -> addAttachment ( $ attachment1 );
$ task -> addAttachment ( $ attachment2 );

$ messageContents = new MessageContents ();
$ messageContents -> setTextBody ( ' text_body ' );
$ messageContents -> setHtmlBody ( ' html_body ' );
$ messageContents -> setSubject ( ' subject ' );

$ transactionEmail -> setTag ( ' tag_tag ' );
$ transactionEmail -> setEmailId ( 5 );
$ transactionEmail -> setSenderCredentials ( $ credentials );
$ transactionEmail -> addTask ( $ task );
$ transactionEmail -> setMessageContents ( $ messageContents );

$ transactionEmail -> send ();

Senden/Massenbenutzerdefinierter E-Mails

Die Implementierung des API-Aufrufs send/custom-emails-bulk : https://app.smartemailing.cz/docs/api/v3/index.html#api-Custom_campaigns-Send_bulk_custom_emails

Vollständiges Beispiel für eine benutzerdefinierte E-Mail 

 $ transactionEmail = $ api -> customEmailsBulkRequest ();

$ credentials = new SenderCredentials ();
$ credentials -> setFrom ( ' [email protected] ' );
$ credentials -> setReplyTo ( ' [email protected] ' );
$ credentials -> setSenderName ( ' Jean-Luc Picard ' );

$ recipient = new Recipient ();
$ recipient -> setEmailAddress ( ' [email protected] ' );

$ replace1 = new Replace ();
$ replace1 -> setKey ( ' key1 ' );
$ replace1 -> setContent ( ' content1 ' );

$ replace2 = new Replace ();
$ replace2 -> setKey ( ' key2 ' );
$ replace2 -> setContent ( ' content2 ' );

$ templateVariable = new TemplateVariable ();
$ templateVariable -> setCustomData ([
    ' foo ' => ' bar ' ,
    ' products ' => [
        [ ' name ' => ' prod1 ' , ' desc ' => ' desc1 ' ],
        [ ' name ' => ' prod1 ' , ' desc ' => ' desc2 ' ]
    ]
]);

$ task = new Task ();
$ task -> setRecipient ( $ recipient );
$ task -> addReplace ( $ replace1 );
$ task -> addReplace ( $ replace2 );
$ task -> setTemplateVariables ( $ templateVariable );

$ transactionEmail -> setTag ( ' tag_tag ' );
$ transactionEmail -> setEmailId ( 5 );
$ transactionEmail -> setSenderCredentials ( $ credentials );
$ transactionEmail -> addTask ( $ task );

$ transactionEmail -> send ();

Senden/Massenbenutzerdefinierte SMS

Die Implementierung des API-Aufrufs send/custom-sms-bulk : https://app.smartemailing.cz/docs/api/v3/index.html#api-Custom_campaigns-Send_bulk_custom_SMS

Vollständiges Beispiel für den SMS-Versand 

 $ bulkCustomSms = $ api -> customSmsBulkRequest ();

$ recipient = new Recipient ();
$ recipient -> setEmailAddress ( ' [email protected] ' );
$ recipient -> setCellphone ( ' +420777888777 ' );

$ replace1 = new Replace ();
$ replace1 -> setKey ( ' key1 ' );
$ replace1 -> setContent ( ' content1 ' );

$ replace2 = new Replace ();
$ replace2 -> setKey ( ' key2 ' );
$ replace2 -> setContent ( ' content2 ' );

$ task = new Task ();
$ task -> setRecipient ( $ recipient );
$ task -> addReplace ( $ replace1 );
$ task -> addReplace ( $ replace2 );

$ bulkCustomSms -> setTag ( ' tag_tag ' );
$ bulkCustomSms -> setSmsId ( 5 );
$ bulkCustomSms -> addTask ( $ task );

$ bulkCustomSms -> send ();

Upgrade

Informationen zum Upgrade auf neuere Versionen finden Sie unter UPGRADE.md.

Beitrag oder Überschreibung

Informationen zum Einbringen von Änderungen finden Sie unter CONTRIBUTING.md. Alle Beiträge sind willkommen.

Urheberrecht und Lizenz

smart-emailing-v3 wurde von Martin Kluska geschrieben und wird unter der MIT-Lizenz veröffentlicht.

Copyright (c) 2016 – 2022 Martin Kluska und Mitwirkende

Expandieren
Zusätzliche Informationen
Ähnliche Anwendungen
Empfohlen für Sie
Ähnliche Nachrichten Alle