Cara menguji permintaan API di Mailchimp

Kami menguji permintaan API di Mailchimp terlebih dahulu agar berhasil mengintegrasikan platform dengan situs.





Permintaan API diperlukan dalam pemasaran email untuk mentransfer data dari situs ke platform buletin. Ini dapat mentransfer pelanggan ke daftar, menambahkan tag ke mereka, mengubah nilai bidang tambahan, mengirim surat pemicu dari platform berdasarkan permintaan.





Dalam platform pemasaran email yang canggih, ini semua tentang pertanyaan seperti ini. Tetapi bahkan dalam proyek kecil, terkadang tidak ada cukup integrasi dasar yang ditawarkan platform, dan Anda perlu membuat permintaan API khusus.





Artikel ini akan berguna bagi pemasar email, membantu mereka mengetahui cara membuat permintaan API di Mailchimp dan meneruskannya ke penyiapan pengembang backend. Di situs, permintaan dikonfigurasi dalam PHP - kami juga akan memberikan contoh permintaan tersebut, tetapi kami akan menganalisis lebih detail permintaan yang akan digunakan pemasar.





Secara teori, pemasaran email harus membaca FAQ untuk API dari Mailchimp dan berdasarkan itu untuk membuat kueri, dan menyiapkan kerangka acuan untuk pertanyaan. Dalam praktiknya, ini bisa memakan waktu dan tenaga.





Saya akan menganalisis contoh permintaan API di Mailchimp yang dapat diuji. Anda dapat mengambil contoh kueri ini, mengubah data untuk proyek Anda, dan menguji.





Persiapan untuk pengujian

Unduh Postman  , sebuah program untuk menguji permintaan API. Di dalamnya, kami akan membuat permintaan dan mengirimkannya ke platform. Jadi mari kita periksa apakah permintaan kita benar dan apakah semua data masuk ke platform.





Selanjutnya, untuk setiap contoh, kami akan menyusun URL permintaan, badan permintaan, dan menguji pekerjaan di Tukang Pos. Dan untuk beberapa - mari tambahkan contoh permintaan untuk PHP, yang mungkin diperlukan oleh pengembang.





Inilah yang terdiri dari antarmuka program.





URL permintaan

Di sini kami menulis URL dan metode permintaan. Ada dua metode permintaan yang paling umum digunakan:





  1. POST jika Anda perlu mentransfer data.





  2. GET , jika Anda perlu mengambil data. Misalnya, jika kami mengumpulkan laporan melalui saluran email di Power BI, maka kami akan menggunakan permintaan GET.





Contoh apa yang kita masukkan di bidang URL akan ada di bawah ini.





tab otorisasi

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

      
      



Badan permintaan sangat sederhana. Statusnya harus aktif , dan di bidang nama kami menulis tag yang ingin kami berikan kepada pengguna. Semua informasi lain, termasuk email pengguna, diteruskan ke url permintaan.





permintaan 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();
}

      
      



Semoga integrasi Anda berhasil!








All Articles