API 数据读取

Question

我对 API 还很陌生，它正在工作。目前，我们正在开发一个网络应用程序供患者监测血压 (BP)，报告将自动在我们的网络应用程序中提供。

我们与一家向我们提供 BP 设备的公司达成协议。一旦患者接受测试，设备就会向我们的回调 URL 发送发送响应。 他们提供的文档让我有点困惑，因为我是 API 的新手。

我可以使用我的 API 密钥和密码生成令牌

 $curl = curl_init();
 curl_setopt_array($curl, array(
 CURLOPT_URL => 'https://xxx/auth/generateToken',
 CURLOPT_RETURNTRANSFER => true,
 CURLOPT_ENCODING => '',
 CURLOPT_MAXREDIRS => 10,
 CURLOPT_TIMEOUT => 0,
 CURLOPT_FOLLOWLOCATION => true,
 CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
 CURLOPT_CUSTOMREQUEST => 'POST',
 CURLOPT_POSTFIELDS =>'{
 "api-key" : "myapikey",
 "pass-phrase" : "passphrase"
 }',
 CURLOPT_HTTPHEADER => array(
'Content-Type: application/json'
 ),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

但是现在生成令牌后我需要做什么？他们会在生成令牌后立即以 json 格式发送报告响应吗？还是我需要发送任何 Get 响应来获得响应？ 这里真的很困惑。

文档

API 令牌可以通过以下 API 调用生成/刷新： http 网址 -- https://xxx/auth/generateToken http方法——POST http 标头 -- Content-Type:application/json 正文：

 {
  "api-key" : "your api key sent to you",
  "pass-phrase" : "passphrase sent to you"
  }
  response :
  {
  "token" : "your api token"
  }

此 API 调用生成的令牌将与读数一起发送 http 标头参数名称（X-CARE-API-TOKEN）中的有效负载。 您可以使用此令牌来验证来源的真实性。

以下是每次读取都会推送的json payload 由设备带到您的 api url。 方法：POST HTTP 标头将是：

1. X-CARE-API-KEY = {您的 API 密钥}
2. X-CARE-API-TOKEN = {您的 api 令牌} HTTP 正文将是：

---

---

用于血压监测设备

---

 {
  "readingData": {
  "id": 572043,
  "device": {
  "name": "Blood Pressure Monitor",
  "serialNumber": "BP800TEST04",
  "manufacturerNumber": "301",
  "model": "800"
  },
  "transmissionTime": 1612940047,
  "readingTime": 1612940041,
  "source": "Device",
  "userNumber": 1,
  "readings": [
  {
  "id": 1,
  "type": "BP Systolic",
  "value": "109",
  "unit": "mm/hg"
  },
  {
  "id": 2,
  "type": "BP Diastolic",
  "value": "145",
  "unit": "mm/hg"
  },
  {
  "id": 3,
  "type": "BP Heartrate",
  "value": "157",
  "unit": "Beats Per Minute"
  },
  {
  "id": 4,
  "type": "Irregular Heartbeat",
  "value": "1"
  },
  {
  "id": 5,
  "type": "Battery Level",
  "value": "98",
  "unit": "Percent"
  },
  {
  "id": 6,
  "type": "Signal Strength",
  "value": "10",
  "unit": "db"
  }
  ]
  }
  }

Answer 1

在生成令牌之后，通常会有另一个 API 调用来实际获取生成的令牌的数据。

它应该是另一个以方法结尾的 URL。 因此会有另一个 CURL 调用。

您的 API 开发人员可能会为此提供一些文档。 或者你可能需要得到他们的支持。