如何在 Python 中格式化 Kartra API 的有效负载

Question

所以，我正在尝试使用 Python requests.post 对此 Kartra 入站 API 进行 API 发布调用。这是我的 Python 代码：

 payload = { 
    'api_key': settings.KARTRA_API_KEY,
    'api_password': settings.KARTRA_API_PASSWORD,
    'app_id': settings.KARTRA_APP_ID,
    'lead': {
        'email': 'joe@joe.com',
        'first_name': 'Joseph',
        'last_name': 'Smith'
    },
    'actions': {
        '0': {'cmd': 'search_lead'}
    }
}
url = settings.KARTRA_API_URL
response = requests.post(url, data=payload)

我必须遵循的唯一示例是 PHP（我没有使用过）。它是这样的：

curl_setopt($ch, CURLOPT_POSTFIELDS,
http_build_query(
    array(
        'app_id' => 'AIm863DwsOW',
        'api_key' => 'QG9GPLW8G',
        'api_password' => 'kdwFAfwrfVS',
        'lead' => array(
            'id' => '3232323223', //you may pass either ID or EMAIL. If both, the system will pick ID
            'email' => 'JoeSmith@domain.com',     
        ),
        'actions' => array(
            '0' => array(
                   'cmd' => 'search_lead',
             ),
        )
  )

) );

我只能得到这样的错误：

{"status":"Error","message":"'actions' not an array","type":"224"}

我已验证我的密钥和令牌似乎工作正常。

我已经尝试了所有我能想到的让端点将“动作”解释为数组的方法。有人可以让我直截了当吗？非常感谢，因为我已经浪费了几个小时来搞砸这个。

Answer 1

如果错误很简单，如'actions' not an array，那么这可能只意味着一件事——actions aren't given as an array。在 Python 中，数组用[] 方括号括起来，花括号{} 用于dictionary 数据结构。

将动作部分简单地更改为数组应该可以解决问题

'actions': [
    {
        0: {'cmd': 'search_lead'}
    }
]

详细 API 还解释了错误 here 的原因。

Answer 2

此 PHP 代码：

       'actions' => array(
            '0' => array(
                   'cmd' => 'search_lead',
             ),

可以解释为list或dict，你可以尝试将PHP位“翻译”成这样：

'actions': [
    {
        'cmd': 'search_lead'
    }
]

---

编辑：。 如果你尝试怎么办：

'actions': [
    {
        0: {'cmd': 'search_lead'}
    }
]

Answer 3

正如我在 cmets 中所说，Kartra 支持无济于事。 Soo... 我将 PHP 示例发送到 https://httpbin.org/post 以了解实际发送的内容。这本身就是一个启示（从来不知道这样的工具）。

这里是 PHP 示例的链接：https://documentation.kartra.com/section-28-php-sample-creating-a-lead/

这是实际发送到 api 的内容：

{
  "args": {}, 
  "data": "", 
  "files": {}, 
  "form": {
    "actions[0][cmd]": "create_lead", 
    "actions[1][cmd]": "assign_tag", 
    "actions[1][tag_name]": "My customer", 
    "api_key": "QG9GPLW8G", 
    "api_password": "kdwFAfwrfVS", 
    "app_id": "AIm863DwsOW", 
    "lead[custom_fields][0][field_identifier]": "text1", 
    "lead[custom_fields][0][field_value]": "text message", 
    "lead[custom_fields][1][field_identifier]": "dropdown1", 
    "lead[custom_fields][1][field_value]": "612", 
    "lead[custom_fields][2][field_identifier]": "checkbox1", 
    "lead[custom_fields][2][field_value][0]": "620", 
    "lead[custom_fields][2][field_value][1]": "621", 
    "lead[email]": "JoeSmith@domain.com", 
    "lead[first_name]": "Joe", 
    "lead[last_name]": "Smith"
  }, 
  "headers": {
    "Accept": "*/*", 
    "Content-Length": "678", 
    "Content-Type": "application/x-www-form-urlencoded", 
    "Host": "httpbin.org", 
    "X-Amzn-Trace-Id": "Root=1-5f77604a-7b5fee841e85d78f6b352133"
  }, 
  "json": null, 
  "origin": "104.14.117.45", 
  "url": "https://httpbin.org/post"
}

这是用于测试的实际工作 Python 代码：

payload = { 
    'api_key': settings.KARTRA_API_KEY,
    'api_password': settings.KARTRA_API_PASSWORD,
    'app_id': settings.KARTRA_APP_ID,
    'lead[email]': 'joe@kartra.com',
    'lead[first_name]': 'Joe',
    'lead[last_name]': 'Smith',
    'actions[0][cmd]': 'create_lead',
}

url = settings.KARTRA_API_URL
response = requests.post(url, data=payload)

我从中学到的另一点是，requests.post() 库不会在 Python dicts of dicts 的第二级以下进行深度复制。有关更多信息，请参阅我的原始问题...

我真的希望这可以帮助某人避免我必须经历的痛苦来解决这个问题。诚然，如果我对 Python、HTTP 和 PHP 有更多了解，并且没有试图避免站出来测试示例代码，那会更容易。生活和学习！