dms / meetup-api-bundle
DMS Meetup API Bundle,为服务中的Meetup API客户端提供支持
Requires
- php: >=5.3.2
- dms/meetup-api-client: ~1.0
This package is auto-updated.
Last update: 2024-09-12 02:55:48 UTC
README
此包利用在 rdohms/meetup-api-client 中分发的Meetup API客户端。它提供用于操作Meetup.com API的客户端实例。
此包是DMS库的一部分,以子目录形式分发,问题应报告在 DMS仓库。
安装
将扩展添加到您的composer文件中
{
"require": {
"dms/meetup-api-bundle": "~1.*"
}
}
或使用composer的require命令
composer require dms/meetup-api-bundle:~1.*
在您的AppKernel中加载该包
<?php
// app/AppKernel.php
public function registerBundles()
{
$bundles = array(
// ...
new DMS\Bundle\MeetupApiBundle\DMSMeetupApiBundle(),
);
}
用法
客户端的每个版本都需要不同的配置,但它们可以并行使用
密钥认证客户端
此客户端使用基于API密钥的简单签名,配置它只需定义密钥即可。
dms_meetup_api:
client:
key: <api-key>
OAuth客户端
OAuth客户端需要更多一些信息才能运行。它有两个部分,消费者密钥和密钥,可以通过配置设置
dms_meetup_api:
client:
consumer_key: <key>
consumer_secret: <secret>
但它还需要一个有效的token
和token secret
,这些必须通过握手获得。您可以使用内置的握手,或者自己进行。获取令牌后,必须使用setSessionTokens($token, $tokenSecret)
方法将它们设置到会话中。
客户端将使用这些令牌来签名未来的请求。
OAuth握手
此包还包含一个用于与Meetup.com API执行OAuth 1.0a握手的内置控制器。它将请求正确的令牌,并在会话中存储访问令牌以在该会话中使用。
握手完成后,它将寻找名为meetup_redirect_url
的路由,如果已定义此路由,则将重定向到该页面,否则重定向到索引页面。
要开始此过程,请将用户重定向到meetup-oauth-authorize
路由。它将获取请求令牌,将用户重定向到授权URL,如果授权,则获取正确的访问令牌。
注入到其他服务中
为了将API客户端(密钥和OAuth)注入到其他服务中,定义了两个服务,它们利用Symfony的服务定义中的工厂方法选项。它们使用可用的工厂方法轻松定义新服务,它们是:
dms_meetup_api.key_client
dms_meetup_api.oauth_client