jlorente / stethome-php-sdk
一个通过综合方式访问 StethoMe API 的 PHP 包。
Requires
- php: >=5.6
- guzzlehttp/guzzle: ~6.0
README
一个通过综合方式访问 StethoMe API 的 PHP 包。
安装
安装此扩展的首选方式是通过 composer。
安装 composer 后,您可以使用以下命令安装扩展
$ php composer.phar require jlorente/stethome-php-sdk
或者添加
... "require": { "jlorente/stethome-php-sdk": "*" }
到您的 composer.json
文件的 require
部分。
配置
您可以通过环境变量设置 STETHOME_VENDOR_TOKEN 或在 StethoMe 类实例化后添加。
环境变量的名称为 STETHOME_VENDOR_TOKEN。
使用方法
必须通过 StethoMe 类执行端点调用。
如果您之前没有设置环境变量,请记住在实例化时提供密钥。
$stethome = new \Jlorente\StethoMe\StethoMe($secretVendorToken); $stethome->pulmonary()->getVisit($visitId);
方法
安全性
getToken
https://dev.middleware.stethome.com/docs/?url=/docs/file/v2/swagger.yaml#/security/get_token
生成客户端设备令牌。
$stethome->security()->getToken();
postToken
https://dev.middleware.stethome.com/docs/?url=/docs/file/v2/swagger.yaml#/security/post_token
生成客户端设备令牌,作用域为给定的访问 ID(推荐)。
$stethome->security()->postToken($params);
肺功能
deleteVisit
删除访问记录。
$stethome->pulmonary()->deleteVisit($visitId);
getVisit
检查与给定访问 ID 相关的所有记录的处理状态。
$stethome->pulmonary()->getVisit($visitId);
getPoint
检查与给定访问 ID 相关的单个记录的处理状态。
$stethome->pulmonary()->getPoint($visitId, $point);
getPointTags
从给定的访问 ID 获取单个记录的分析标签。
$stethome->pulmonary()->getPointTags($visitId, $point);
getPointWav
获取用于回放的单一记录音频文件。
$stethome->pulmonary()->getPointWav($visitId, $point);
getVisitId
生成访问 ID。所有后续客户端请求都必须发送此 ID,以便正确地将所有记录匹配到同一访问。
$stethome->pulmonary()->getVisitId();
postVisitContent
添加访问内容。
$stethome->pulmonary()->postVisitContent($visitId, array $parameters = []);
copyVisit
创建访问复制令牌。
$stethome->pulmonary()->copyVisit($visitId);
lockVisit
锁定访问。
$stethome->pulmonary()->lockVisit($visitId);
许可证
版权 © 2020 José Lorente Martín jose.lorente.martin@gmail.com.
根据 BSD 3-Clause 许可证许可。有关详细信息,请参阅 LICENSE.txt。