README

此仓库包含PHP SDK和Symfony 2 SDK Bundle，允许您访问符合PHPPRO API规则的任何API。

使用方法

Symfony 2集成（SDK Bundle）

此版本的Bundle需要Symfony 2.5+。

安装

安装是一个简单的4步过程

1. 使用composer下载phppro/sdk
2. 启用Bundle
3. 配置应用程序的security.yml
4. 配置SdkBundle

步骤1：使用composer下载phppro/sdk

将phppro/sdk依赖添加到您的composer.json

# composer.json
{
    "require": {
        "phppro/sdk": "1.*"
    },

    ...
}

然后更新

$ php composer.phar update phppro/sdk

Composer会将Bundle安装到您的项目目录的vendor/phppro/sdk以及所需的附加包。

步骤2：启用Bundle

在kernel中启用Bundle

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new Phppro\Sdk\SdkBundle(),
    );
}

步骤3：配置应用程序的security.yml

# app/config/security.yml
security:
    encoders:
        phppro\Common\SdkBundle\Security\User\ApiUser:
          id: sdk.api.password_encoder

    role_hierarchy:
        ...

    providers:
        api:
          id: sdk.api.user_provider

    firewalls:
        ...

步骤4：配置phpproCommonSdkBundle

# app/config/config.yml
phppro_common_sdk:
  host:     "%api.host%"
  login:    "%api.login%"
  password: "%api.password%"
  clientId: "%api.clientId%"

您可以将所有%api.*%参数添加到app/config/parameters.yml(.dist)

# app/config/parameters.yml
    # contact phppro dev team to obtain the appropriate host name
    api.host: api.phppro.com
    # contact phppro dev team to obtain the appropriate login name
    api.login: mylogin
    # contact phppro dev team to obtain the appropriate password hash
    api.password: abcd1234...
    # contact phppro dev team to obtain the appropriate client id
    api.clientId: myclient

还有更多的Bundle配置参数可用，但为可选（redis缓存令牌...）

下一步

联系phppro开发团队获取更多信息。