具有散列数组的curl API调用

Question

我们使用的是一个名为FreezerPro (https://www.freezerpro.com/product-tour)的服务器软件，其API可以通过编程方式调用。有一些像freezers这样的简单方法可以处理如下的curl调用：

freezers -- Retrive a list of freezers
Returned objects: Freezers
Required parameters: None
Optional query parameters: None
Optional control parameters: None

curl -g --insecure 'https://username:password@demo-usa.freezerpro.com/api?method=freezers' | jq . | head -n 12
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100  8697    0  8697    0     0  15980      0 --:--:-- --:--:-- --:--:-- 15987
{
  "Freezers": [
    {
      "rfid_tag": "355AB1CBC00000700000075A",
      "barcode_tag": "7000001882",
      "boxes": 0,
      "subdivisions": 1,
      "access": 0,
      "description": "[1000000000]",
      "name": "[1000000000]",
      "id": 1882
    },

然后有一个search_samples方法，它搜索给定query的样本中的任何字段。例如：

search_samples -- search for samples:
Returned objects: Samples
Required parameters: None
Optional query parameters:
query = <filter text> optional search string to filter the results.
Optional control parameters:
start = <staring record>
limit = <limit number of records to retrieve>
sort = <sort_field>
dir = <ASC / DESC>

curl -g --insecure 'https://username:password@demo-usa.freezerpro.com/api?method=search_samples&query=111222333' | jq .                                                                      
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   347    0   347    0     0    977      0 --:--:-- --:--:-- --:--:--   977
{
  "Samples": [
    {
      "created_at": "06/11/2018",
      "owner_id": 45,
      "owner": "<span ext:qtip=\"username\">username</span>",
      "description": "test",
      "sample_id": 53087,
      "id": 53087,
      "loc_id": 54018,
      "type": "cfDNA",
      "scount": 1,
      "name": "123456AB",
      "location": "ER111&rarr;Level 1&rarr;Level 2&rarr;test001 (1)",
      "icon": "images/box40/i53.png"
    }
  ],
  "Total": 1
}

到目前一切尚好。这个问题出现在试图运行advanced_search查询时，该查询在查询部分中使用了一个散列数组。给定上面的示例，其中有一个名为patient_id的udf，其值为111222333，对于udf patient_id value=111222333的advanced_search查询应该返回一些内容，但它只是提供了一个空白结果：

​

​

示例命令：

curl -g --insecure 'https://username:password@demo-usa.freezerpro.com/api?method=advanced_search&subject_type=Sample&query=[{type="udf",field="patient_id",value=111222333}]'

我正在使用：

curl --version
curl 7.35.0 (x86_64-pc-linux-gnu) libcurl/7.35.0 OpenSSL/1.0.1f zlib/1.2.8 libidn/1.28 librtmp/2.3
Protocols: dict file ftp ftps gopher http https imap imaps ldap ldaps pop3 pop3s rtmp rtsp smtp smtps telnet tftp 
Features: AsynchDNS GSS-Negotiate IDN IPv6 Largefile NTLM NTLM_WB SSL libz TLS-SRP 

这与curl解释/传递query部分的方式有关吗？

关于如何构造查询，有什么想法吗？这是curl特有的问题吗？

编辑:尝试了curl urlencode，它抱怨查询没有被设置：

curl -g -G --insecure  'https://username:password@demo-usa.freezerpro.com/api' --data-urlencode 'method=advanced_search' --data-urlencode 'query=[{type="udf",field="patient_id",value=111222333}]'
{"error":true,"message":"Query or search conditions must be specified","success":false}

Answer 1

我找到了一个使用--data标志和-k标志的解决方案：

curl -k --header "Content-Type: application/json" --request GET --data '{"username":"user", "password":"password", "method":"advanced_search", "query":[{"type":"udf","field":"patient_id","op":"eq","value":"111222333"}], "udfs":["patient_id","other"]}' https://demo-usa.freezerpro.com/api | jq .

Answer 2

您必须对URL参数的值进行URL编码。例如：

curl -g --insecure 'https://username:password@demo-usa.freezerpro.com/api?method=advanced_search&subject_type=Sample&query=%5B%7Btype%3D%22udf%22%2Cfield%3D%22patient_id%22%2Cvalue%3D111222333%7D%5D'

另外，请使用-v参数运行curl，使其详细，这样我们至少可以知道返回了什么HTTP状态。