Página Inicial>Código fonte PHP>Outras categorias
Baixar

API de e-mail inteligente v3

Wrapper de API para API de e-mail inteligente.

  • Instalação
  • Uso
  • Suporta
  • Documentos avançados
  • Contribuição ou substituição
  • Atualizando
  • Direitos autorais e licença
  • API de e-mail inteligente

Instalação

Requisitos

Este pacote requer PHP 7.4 e superior.

Instalar via compositor 

 composer require pion/smart-emailing-v3

Uso

Crie uma instância da API com seu nome de usuário e apiKey. 

 use SmartEmailing  v3  Api ;

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

em seguida, use $api com o método/componente desejado. 

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

ou 

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

Tratamento de erros

Ao enviar qualquer solicitação você pode capturar a exceção de erro 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
}

Suporta

  • Importar contatos
  • Pedidos de importação
  • Pingar
  • Credenciais
  • Lista de contatos
  • Campos personalizados
    • Campos personalizados - criar
    • Campos personalizados - pesquisa/lista
    • Campos personalizados - resto
    • Campos personalizados - opções
  • Contatos
  • Contatos na lista
  • E-mails personalizados
  • E-mails
  • Boletim informativo
  • Webhooks
  • (DESCONTINUADO) Lojas eletrônicas

Documentos avançados

Importar contatos

A importação contém 2 pontos de dados principais:

  1. Configurações $import->settings()->setUpdate(true)
  2. Contatos $import->newContact() : Contact , $import->contacts() : array e $import->addContact($contact) : self

Um exemplo de uso está acima.

Contato

A importação contém três pontos de dados principais:

  1. Todos os dados acessíveis através de propriedades públicas. O método Fluent Set possui validação básica e lógica de conversão de data
  2. CustomFields $contact->customFields() para adicionar novos campos
  3. ContactLists $contact->contactLists() para adicionar nova lista de contatos

Veja o código fonte para todos os métodos/propriedades que você pode usar

Campos personalizados e listas de contatos

Usa um detentor de dados com métodos create / add / get / isEmpty / toArray / jsonSerialize . 

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

Pedidos de importação

A importação contém 2 pontos de dados principais:

  1. Configurações $import->settings()->setSkipInvalidOrders(true)
  2. Pedidos $import->newOrder() : Order , $import->orders() : array e $import->addOrder($order) : self

Um exemplo de uso está acima.

Campos Personalizados

O customFields usa um wrapper para cada solicitação relacionada a campos personalizados. Para criar uma nova instância, chame $api->customFields() . Neste objeto você pode criar qualquer solicitação que esteja implementada atualmente. Veja abaixo.

Criar

Maneira rápida de criar uma solicitação com o customField necessário 

 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 ;

ou 

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

Pesquisa / Lista

DOCUMENTOS DE API

Permite a pesquisa em campos personalizados com suporte de filtro/classificação. Os resultados são limitados a 100 por página. A resposta retorna metadados (MetaDataInterface) e uma matriz de ModelsCustomFieldDefinition chamando $response->data() .

Resposta

  • data() retorna uma matriz ModelsCustomFieldDefinition
  • meta() retorna uma stdClass com propriedades (definidas em MetaDataInterface )

Obtenha uma lista sem pesquisa avançada

Cria uma solicitação de pesquisa e configura apenas $page ou $limit . A resposta completa da API com customfield_options_url ou 

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

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

Pesquisa avançada - filtrar/classificar/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 solicitação
  • Getters são via propriedade pública
    • página
    • limite
    • selecione
    • expandir
    • organizar
  • Fluent Setters (com validação) - mais abaixo.
  • filter() retorna uma configuração de Filtros - mais abaixo
expandBy(string: $expandir)

Usando este parâmetro, a propriedade "customfield_options_url" será substituída por "customfield_options" contendo dados expandidos. Veja os exemplos abaixo Para obter mais informações, consulte o endpoint "/customfield-options".

Valores permitidos: "customfield_options"

selecione(string: $selecione)

Lista separada por vírgulas de propriedades a serem selecionadas. por exemplo. "?select=id,name" Se não for fornecido, todos os campos serão selecionados.

Valores permitidos: "id", "nome", "tipo"

sortBy(string: $sort)

Lista separada por vírgulas de chaves de classificação do lado esquerdo. Anexe "-" a qualquer tecla para direção de descrição, por exemplo. "?sort=tipo,-nome"

Valores permitidos: "id", "nome", "tipo"

setPage(int: $página)

Define a página atual

limite(int: $limite)

Define o limite do resultado em uma única consulta

filtro()

Permite filtrar campos personalizados com múltiplas condições de filtro.

  • Getters são via propriedade pública
    • nome
    • tipo
    • eu ia
  • Fluent Setters (com validação)
    • porNome($valor)
    • porTipo($valor)
    • porId($valor)

Obter pelo nome

Executa uma consulta de pesquisa com filtro de nome e verifica se o nome fornecido é encontrado em customFields. Retorna false ou CustomFieldsCustomField . Usa lógica de envio (lança RequestException). 

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

Enviar/e-mails transacionais

A implementação da chamada de API send/transactional-emails-bulk : https://app.smartemailing.cz/docs/api/v3/index.html#api-Custom_campaigns-Send_transactional_emails

Exemplo completo de email transacional 

 $ 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/e-mails personalizados em massa

A implementação da chamada de API send/custom-emails-bulk : https://app.smartemailing.cz/docs/api/v3/index.html#api-Custom_campaigns-Send_bulk_custom_emails

Exemplo completo de e-mail personalizado 

 $ 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 em massa

A implementação da chamada de API send/custom-sms-bulk : https://app.smartemailing.cz/docs/api/v3/index.html#api-Custom_campaigns-Send_bulk_custom_SMS

Exemplo completo de envio 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 ();

Atualizando

Consulte UPGRADE.md para saber como atualizar para versões mais recentes.

Contribuição ou substituição

Consulte CONTRIBUTING.md para saber como contribuir com alterações. Todas as contribuições são bem-vindas.

Direitos autorais e licença

smart-emailing-v3 foi escrito por Martin Kluska e é lançado sob a licença MIT.

Copyright (c) 2016 - 2022 Martin Kluska e colaboradores

Expandir
Informações adicionais
Aplicativos Relacionados
Recomendado para você
Informações Relacionadas Todos