Cómo probar solicitudes de API en Mailchimp

Probamos las solicitudes de API en Mailchimp por adelantado para integrar con éxito la plataforma con el sitio.





Las solicitudes de API son necesarias en el marketing por correo electrónico para transferir datos del sitio a la plataforma del boletín. Esto puede ser transferir suscriptores a la lista, agregarles etiquetas, cambiar los valores de campos adicionales, enviar cartas de activación desde la plataforma a pedido.





En plataformas sofisticadas de marketing por correo electrónico, todo se trata de consultas como esta. Pero incluso en proyectos pequeños, a veces no hay suficientes integraciones básicas que ofrece la plataforma y es necesario realizar solicitudes de API personalizadas.





Este artículo será útil para los especialistas en marketing por correo electrónico, ya que les ayudará a descubrir cómo crear solicitudes de API en Mailchimp y pasarlas a la configuración del desarrollador de backend. En el sitio, la solicitud está configurada en PHP; también daremos un ejemplo de dichas solicitudes, pero analizaremos con más detalle las solicitudes que utilizará el comercializador.





En teoría, el marketing por correo electrónico debería leer las preguntas frecuentes de la API de Mailchimp y, sobre su base, crear consultas y preparar términos de referencia para las consultas. En la práctica, esto puede llevar mucho tiempo y trabajo.





Analizaré ejemplos de solicitudes de API en Mailchimp que se pueden probar. Puede tomar ejemplos de estas consultas, cambiar los datos de su proyecto y probar.





Preparándose para la prueba

Descarga Postman  , un programa para probar solicitudes de API. En él, redactaremos una solicitud y la enviaremos a la plataforma. Entonces, verifiquemos si nuestra solicitud es correcta y si todos los datos llegan a la plataforma.





A continuación, para cada ejemplo, redactaremos la URL de la solicitud, el cuerpo de la solicitud y probaremos el trabajo en Postman. Y para algunos, agreguemos una solicitud de ejemplo para PHP, que puede ser requerida por el desarrollador.





En esto consiste la interfaz del programa.





Solicitar URL

Aquí escribimos la URL y el método de la solicitud. Hay dos métodos de solicitud más utilizados:





  1. POST si necesita transferir datos.





  2. GET, . ,    email  Power BI,   GET .





,   URL, .





Authorization

. , API.





, ExpertSender : . API Toggl, Toggl-. Mailchimp Basic Auth, API key. , Username , Password — API key.





, , API Mailchimp , . — .





API key   Account → Extras → API keys:





API key API Mailchimp , .





. , . , , , , . JSON XML.





: , , . , , .





Response

Postman  .





   - ,     .     201 created,    API .





   : , ,

    .





URL

https://<dc>.api.Mailchimp.com/3.0/lists/{list_id}/members/

      
      



:





  • {list_id} — id ,   ,     ;





  • dc —  Mailchimp:   .





  us17.





{
  "email_address": "youremail@gmail.com",
  "status": "subscribed",
  "merge_fields": {
  "FIRSTNAME": "",
  "LASTNAME": ""
  }
}

      
      



:





  • email_address — , ;





  • status —    : subscribed;





  • merge_fields — , .





.   :





  • subscribed —   ;





  • pending — Double Opt-In ( )  ;





  • unsubscribed —  ;





  • cleaned —   - .





    ,    .





  :  .       ,    . ,   ,    Mailchimp,    .   Merge Fields   .





  .   MERGE ,   Field label and type.  :





,   , .      . ,     . ,    ,  Postman  .     — .





  : .





PHP

backend ,  .





require_once('/path/to/MailchimpMarketing/vendor/autoload.php');

$Mailchimp = new \MailchimpMarketing\ApiClient();
$Mailchimp->setConfig([
    'apiKey' => 'YOUR_API_KEY',
    'server' => 'YOUR_SERVER_PREFIX'
]);
$email = "urist.mcvankab@example.com";
$list_id = "YOUR_LIST_ID";
try {
    $response = $client->lists->addListMember($list_id, [
        "email_address" => "prudence.mcvankab@example.com",
        "status" => "subscribed",
        "merge_fields" => [
          "FNAME" => "Prudence",
          "LNAME" => "McVankab"
        ]
    ]);
    $response = $Mailchimp->lists->addListMember($list_id, $contact);
    // TODO: Get the new member's ID from the response and echo it
    //echo "Successfully added contact as an audience member. The contact's id is {$response->getId()}.";
} catch (MailchimpMarketing\ApiException $e) {
    echo $e->getMessage();
}

      
      



 

URL

https://<dc>.api.Mailchimp.com/3.0/automations/<workflow id>/emails/<email id>/queue

      
      



  :





  • workflow id,





  • email id.





  .     GET . POST -    , ,  GET .  url:





workflow id:





https://<dc>.api.Mailchimp.com/3.0/automations/

      
      



  Postman   ,  . API 3.0.      .





id —  , . id . :





https://<dc>.api.Mailchimp.com/3.0/automations/<workflow i>/emails

      
      



 , email id.     .





{
  "email_address": "youremail@gmail.com"
}

      
      



email . , ,   .   ,    —    .





URL

https:/<dc>.api.Mailchimp.com/3.0/lists/{list_id}/members/<member_id>/tags

      
      



<member_id> — ,   ,  md5 hash   md5 Hash Generator. , Mailchimp  —  url   .     hash,  url .





{
      "tags": [
        {
            "name": "product",
            "status": "active"
        }
    ]
}

      
      



El cuerpo de la solicitud es muy simple. El estado debe estar activo , y en el campo de nombre escribimos la etiqueta que queremos asignar al usuario. Toda la demás información, incluido el correo electrónico del usuario, se transmite a la URL de la solicitud.





Solicitud de PHP

require_once('/path/to/MailchimpMarketing/vendor/autoload.php');

$Mailchimp = new MailchimpMarketing\ApiClient();
$Mailchimp->setConfig([
    'apiKey' => 'YOUR_API_KEY',
    'server' => 'YOUR_SERVER_PREFIX'
]);
$list_id = "YOUR_LIST_ID";
$tag = new MailchimpMarketing\Model\List7();
$tag->setName("MegaInfluencer");
$tag->setStaticSegment(["dolly.parton@example.com", "rihanna@example.com"]);
try {
    $response = $Mailchimp->lists->createSegment($list_id, $tag);
    echo "Tag successfully created! Your tag id is " . $response->getId();
} catch (MailchimpMarketing\ApiException $e) {
    echo $e->getMessage();
}

      
      



¡Le deseamos integraciones exitosas!








All Articles