Inicio>código fuente PHP>Otras categorias
Descargar

API de correo electrónico inteligente v3

Envoltorio de API para API de correo electrónico inteligente.

  • Instalación
  • Uso
  • Soportes
  • Documentos avanzados
  • Contribución o prima
  • Actualización
  • Derechos de autor y licencia
  • API de correo electrónico inteligente

Instalación

Requisitos

Este paquete requiere PHP 7.4 y superior.

Instalar a través del compositor 

 composer require pion/smart-emailing-v3

Uso

Cree una instancia de Api con su nombre de usuario y apiKey. 

 use SmartEmailing  v3  Api ;

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

luego use $api con el método/componente deseado. 

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

o 

 // 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 ();

Manejo de errores

Al enviar cualquier solicitud, puede detectar la excepción de error RequestException . 

 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
}

Soportes

  • Importar contactos
  • Pedidos de importación
  • Silbido
  • Cartas credenciales
  • Lista de contactos
  • Campos personalizados
    • Campos personalizados - crear
    • Campos personalizados: búsqueda/lista
    • Campos personalizados - descanso
    • Campos personalizados - opciones
  • Contactos
  • Contactos en la lista
  • Correos electrónicos personalizados
  • Correos electrónicos
  • Hoja informativa
  • Ganchos web
  • (OBSECUTIVO) Tiendas electrónicas

Documentos avanzados

Importar contactos

La importación contiene 2 puntos de datos principales:

  1. Configuración $import->settings()->setUpdate(true)
  2. Contactos $import->newContact() : Contact , $import->contacts() : array y $import->addContact($contact) : self

Un ejemplo de uso está arriba.

Contacto

La importación contiene 3 puntos de datos principales:

  1. Todos los datos accesibles a través de propiedades públicas. El método de conjunto fluido tiene lógica básica de validación y conversión de fecha
  2. CustomFields $contact->customFields() para agregar nuevos campos
  3. ContactLists $contact->contactLists() para agregar una nueva lista de contactos

Consulte el código fuente para conocer todos los métodos/propiedades que puede utilizar

Campos personalizados y listas de contactos

Utiliza un contenedor de datos con métodos create / add / get / isEmpty / toArray / jsonSerialize . 

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

Pedidos de importación

La importación contiene 2 puntos de datos principales:

  1. Configuración $import->settings()->setSkipInvalidOrders(true)
  2. Órdenes $import->newOrder() : Order , $import->orders() : array y $import->addOrder($order) : self

Un ejemplo de uso está arriba.

Campos personalizados

CustomFields utiliza un contenedor para cada solicitud relacionada con campos personalizados. Para crear una nueva instancia, llame $api->customFields() . En este objeto puede crear cualquier solicitud que esté implementada actualmente. Vea abajo.

Crear

Manera rápida que creará una solicitud con el campo personalizado requerido 

 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 ;

o 

 $ 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 ;

Buscar / Lista

DOCUMENTOS API

Permite la búsqueda en campos personalizados con soporte de filtro/clasificación. Los resultados están limitados a 100 por página. La respuesta devuelve metadatos (MetaDataInterface) y una matriz de ModelsCustomFieldDefinition llamando $response->data() .

Respuesta

  • data() devuelve una matriz ModelsCustomFieldDefinition
  • meta() devuelve una stdClass con propiedades (definidas en MetaDataInterface )

Obtener una lista sin búsqueda avanzada

Crea una solicitud de búsqueda y configura solo $page o $limit . La respuesta completa de la API con customfield_options_url o 

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

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

Búsqueda avanzada: filtrar/ordenar/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 ();
Métodos de solicitud
  • Los captadores son a través de propiedad pública.
    • página
    • límite
    • seleccionar
    • expandir
    • clasificar
  • Fluent Setters (con validación): más información a continuación.
  • filter() devuelve una configuración de filtros; más información a continuación
expandirBy(cadena: $expandir)

Al utilizar este parámetro, la propiedad "customfield_options_url" se reemplazará por "customfield_options" que contiene datos expandidos. Vea los ejemplos a continuación. Para obtener más información, consulte el punto final "/customfield-options".

Valores permitidos: "customfield_options"

seleccionar (cadena: $ seleccionar)

Lista separada por comas de propiedades para seleccionar. p.ej. "?select=id,name" Si no se proporciona, se seleccionan todos los campos.

Valores permitidos: "id", "nombre", "tipo"

ordenar por (cadena: $ ordenar)

Lista separada por comas de claves de clasificación del lado izquierdo. Anteponga "-" a cualquier tecla para la dirección de descripción, por ejemplo. "?ordenar=tipo,-nombre"

Valores permitidos: "id", "nombre", "tipo"

setPage(int: $página)

Establece la página actual

límite(int: $límite)

Establece el límite de resultado en una sola consulta.

filtrar()

Permite filtrar campos personalizados con múltiples condiciones de filtrado.

  • Los captadores son a través de propiedad pública.
    • nombre
    • tipo
    • identificación
  • Configuradores fluidos (con validación)
    • porNombre($valor)
    • por tipo($valor)
    • porId($valor)

Obtener por nombre

Ejecuta una consulta de búsqueda con filtro de nombre y comprueba si el nombre de pila se encuentra en customFields. Devuelve false o CustomFieldsCustomField . Utiliza lógica de envío (lanza RequestException). 

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

Enviar / correos electrónicos transaccionales

La implementación de la llamada API send/transactional-emails-bulk : https://app.smartemailing.cz/docs/api/v3/index.html#api-Custom_campaigns-Send_transactional_emails

Ejemplo completo de correo electrónico transaccional 

 $ 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 ();

Enviar/correos electrónicos personalizados masivos

La implementación de la llamada API send/custom-emails-bulk : https://app.smartemailing.cz/docs/api/v3/index.html#api-Custom_campaigns-Send_bulk_custom_emails

Ejemplo de correo electrónico personalizado completo 

 $ 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 ();

Enviar / SMS personalizados masivos

La implementación de la llamada API send/custom-sms-bulk : https://app.smartemailing.cz/docs/api/v3/index.html#api-Custom_campaigns-Send_bulk_custom_SMS

Ejemplo completo de envío de sms 

 $ 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 ();

Actualización

Consulte UPGRADE.md para saber cómo actualizar a versiones más recientes.

Contribución o prima

Consulte CONTRIBUTING.md para saber cómo contribuir con cambios. Todas las contribuciones son bienvenidas.

Derechos de autor y licencia

smart-emailing-v3 fue escrito por Martin Kluska y se publica bajo la licencia MIT.

Copyright (c) 2016 - 2022 Martin Kluska y colaboradores

Expandir
Información adicional
Aplicaciones relacionadas
Recomendado para ti
Información relacionada Todo