♌️ 🧑🏿‍🤝‍🧑🏻 ⛹🏼 Comment tester les requêtes API dans Mailchimp 🧝🏽 ㊙️ 🛩️

Nous testons à l'avance les requêtes API dans Mailchimp pour réussir l'intégration de la plateforme au site.

Les demandes d'API sont nécessaires dans le marketing par e-mail afin de transférer les données du site vers la plateforme de newsletter. Cela peut consister à transférer des abonnés à la liste, à leur ajouter des balises, à modifier les valeurs de champs supplémentaires, à envoyer des lettres de déclenchement depuis la plate-forme sur demande.

Dans les plateformes de marketing par e-mail sophistiquées, tout tourne autour de requêtes comme celle-ci. Mais même dans les petits projets, il n'y a parfois pas assez d'intégrations de base proposées par la plate-forme et vous devez faire des demandes d'API personnalisées.

Cet article sera utile aux spécialistes du marketing par e-mail, en les aidant à comprendre comment créer des demandes d'API dans Mailchimp et les transmettre à la configuration du développeur backend. Sur le site, la requête est configurée en PHP - nous donnerons également un exemple de telles requêtes, mais nous analyserons plus en détail les requêtes que le marketeur utilisera.

En théorie, le marketing par e-mail devrait lire la FAQ pour l'API de Mailchimp et sur sa base pour créer des requêtes et préparer des termes de référence pour les requêtes. En pratique, cela peut prendre du temps et demander beaucoup de travail.

Je vais analyser des exemples de requêtes API dans Mailchimp qui peuvent être testées. Vous pouvez prendre des exemples de ces requêtes, modifier les données de votre projet et tester.

Préparation aux tests

Téléchargez Postman , un programme pour tester les requêtes API. Dans celui-ci, nous composerons une demande et l'enverrons à la plateforme. Vérifions donc si notre demande est correcte et si toutes les données parviennent à la plateforme.

Ensuite, pour chaque exemple, nous allons composer l'URL de la requête, le corps de la requête et tester le travail dans Postman. Et pour certains, ajoutons un exemple de requête pour PHP, qui peut être requis par le développeur.

C'est en cela que consiste l'interface du programme.

URL de demande

Ici, nous écrivons l'URL et la méthode de la requête. Il existe deux méthodes de requête les plus couramment utilisées :

POST si vous avez besoin de transférer des données.
GET , si vous avez besoin de récupérer des données. Par exemple, si nous collectons un rapport par canal de messagerie dans Power BI, nous utiliserons les requêtes GET.

Des exemples de ce que nous entrons dans le champ URL seront ci-dessous.

Onglet Autorisation

. , 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"
        }
    ]
}

Le corps de la requête est très simple. Le statut doit être actif , et dans le champ du nom, nous écrivons la balise que nous voulons attribuer à l'utilisateur. Toutes les autres informations, y compris l'e-mail de l'utilisateur, sont transmises à l'URL de la demande.

requête 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();
}

Nous vous souhaitons des intégrations réussies !

Comment tester les requêtes API dans Mailchimp