README

此库旨在简化您在 PHP 应用程序中使用 Symplur API。

医疗社交图谱

Symplur API 提供了对 Healthcare Social Graph® 的访问，这是由 Symplur 精心挑选并由机器学习提供支持的庞大神经网络，包括公共医疗社区、对话和人物。

快速开始

首先，联系 Symplur 获取您的 API 凭据。这将包括一个客户端 ID 和一个客户端密钥，代表您的组织。然后使用 Composer 安装此库，并通过输入这些字符串构建客户端对象。就这样！您就可以开始使用了。

# composer require symplur/sdk

<?php
require_once 'vendor/autoload.php';

use Symplur\Api\Client;

$client = new Client($clientId, $clientSecret);

$data = $client->get('twitter/analytics/people/influencers', [
    'databases' => '#hcsm, #bcsm',
    'start' => '1 week ago',
    'end' => 'yesterday'
]);

开始您的旅程的好地方是首先阅读入门文档。有关端点、输入和输出的详细信息，请参阅Symplur API 文档。

客户端参考

Symplur\Api\Client 类是您将使用的 SDK 主接口。以下是一些参考

__construct($clientId, $clientSecret, array $options = [])

• $clientId (字符串) 您的 Symplur 客户端 ID
• $clientSecret (字符串) 您的 Symplur 客户端密钥
• $options - (数组) 传递给构造函数的额外配置参数，用于Guzzle HTTP 客户端，它用于内部。注意：此数组通常不是必需的。

get($relativePath, array $query = [])

使用此方法执行对 API 端点的 GET 请求。

• $relativePath (字符串) 端点 URL 路径，相对于 API 的基本 URI
• $query (数组) 可选参数作为 URL 查询字符串传递

示例

$data = $client->get('foo/zat', [
	'offset' => 10,
	'limit' => 20
]);

post($relativePath, array $formParams = [])

使用此方法执行对 API 端点的 POST 请求。

• $relativePath (字符串) 相对于 API 基本 URI 的端点路径
• $formParams (数组) 可选参数作为请求体传递

示例

$data = $client->post('/foo/zat', [
	'name' => 'Thing 1',
	'description' => 'Lorem ipsum dolor...'
]);

put($relativePath, array $formParams = [])

使用此方法执行对 API 端点的 PUT 请求。

• $relativePath (字符串) 相对于 API 基本 URI 的端点路径
• $formParams (数组) 可选参数作为请求体传递

示例

$data = $client->put('/foo/zat/12345', [
	'name' => 'Thing 1',
	'description' => 'Lorem ipsum dolor...'
]);

patch($relativePath, array $formParams = [])

使用此方法执行对 API 端点的 PATCH 请求。

• $relativePath (字符串) 相对于 API 基本 URI 的端点路径
• $formParams (数组) 作为请求体传递的参数。假定使用 RFC 7396 Json Merge Patch 格式。

示例

$data = $client->patch('/foo/zat/12345', [
	'description' => 'Lorem ipsum dolor...'
]);

delete($relativePath, array $formParams = [])

使用此方法执行对 API 端点的 DELETE 请求。

• $relativePath (字符串) 相对于 API 基本 URI 的端点路径
• $formParams (数组) 可选参数作为请求体传递

示例

$data = $client->delete('/foo/zat/12345');

测试

测试套件基于 PHPUnit 构建。包括一个简单的 phpunit.xml 配置文件。您可以这样运行测试

./vendor/bin/phpunit

贡献者

SDK 开发由 Symplur 工程师管理。欢迎您的反馈和 pull 请求！

许可

此 SDK 在 MIT 许可证的条款下提供。有关详细信息，请参阅 LICENSE。