README

安装

您至少需要PHP 7.4。我们匹配官方支持的PHP版本。

使用 Composer 包管理器安装包的最新版本

composer require samoritano/linkedin-api-php-client

或将此包添加到 composer.json 中的依赖项。

开始使用

在您开始之前，请访问 LinkedIn API 文档。这将节省您大量时间并防止一些愚蠢的问题。

要开始使用LinkedIn API，您需要获取应用程序客户端ID和密钥。

访问 LinkedIn开发者门户 并在“我的应用”部分创建新应用。一旦您的应用获得批准，您将获得客户端ID和客户端密钥，您将在以后使用它们。

引导自动加载器和实例化客户端

// ... please, add composer autoloader first
include_once __DIR__ . DIRECTORY_SEPARATOR . 'vendor' . DIRECTORY_SEPARATOR . 'autoload.php';

// import client class
use LinkedIn\Client;

// instantiate the Linkedin client
$client = new Client(
    'YOUR_LINKEDIN_APP_CLIENT_ID',
    'YOUR_LINKEDIN_APP_CLIENT_SECRET'
);

获取本地重定向URL

要开始链接过程，您必须设置重定向URL。您可以设置自己的或使用当前的。SDK为您提供了一个方便的 getRedirectUrl() 助手。

$redirectUrl = $client->getRedirectUrl();

我们建议您在链接会话期间保存它，因为您将在获取访问令牌时需要使用它。

设置本地重定向URL

设置自定义重定向URL

$client->setRedirectUrl('http://your.domain.tld/path/to/script/');

获取LinkedIn重定向URL

为了执行OAuth 2.0流程，您应该获取LinkedIn登录URL。在此过程中，您必须定义请求的权限范围。

您可以在此处了解更多关于LinkedIn API权限的信息。

使用 Scope 枚举类来获取权限名称。要获取到LinkedIn的重定向URL，请使用以下方法

use LinkedIn\Scope;

// define scope
$scopes = [
  Scope::READ_LITE_PROFILE,
  Scope::READ_EMAIL_ADDRESS,
  Scope::SHARE_AS_USER,
  Scope::SHARE_AS_ORGANIZATION,
];
$loginUrl = $client->getLoginUrl($scopes); // get url on LinkedIn to start linking

现在您可以将用户带到LinkedIn。您可以使用链接或依赖于Location HTTP头。

获取访问令牌

要获取访问令牌，请使用（不要忘记设置重定向URL）

$accessToken = $client->getAccessToken($_GET['code']);

此方法返回 LinkedIn\AccessToken 类的对象。您可以像这样将此令牌存储在文件中

file_put_contents('token.json', json_encode($accessToken));

由于安全顾虑，不建议以这种方式存储令牌，并且仅用于演示目的。请确保安全地存储令牌。

设置访问令牌

您可以使用 LinkedIn\Client 类的 setAccessToken() 方法来设置存储为字符串的令牌。您必须向此方法传递 LinkedIn\AccessToken 实例。

use LinkedIn\AccessToken;
use LinkedIn\Client;

// instantiate the Linkedin client
$client = new Client(
    'LINKEDIN_APP_CLIENT_ID',
    'LINKEDIN_APP_CLIENT_SECRET'
);

// load token from the file
$tokenString = file_get_contents('token.json');
$tokenData = json_decode($tokenString, true);
// instantiate access token object from stored data
$accessToken = new AccessToken($tokenData['token'], $tokenData['expiresAt']);

// set token for client
$client->setAccessToken($accessToken);

执行API调用

所有API调用都可以通过简单的方法调用

$profile = $client->api(
    'ENDPOINT',
    ['parameter name' => 'its value here'],
    'HTTP method like GET for example'
);

有3个辅助方法

// get method
$client->get('ENDPOINT', ['param' => 'value']);

//post
$client->post('ENDPOINT', ['param' => 'value']);

// delete
$client->delete('ENDPOINT');

示例

执行API调用以获取配置文件信息

$profile = $client->get(
    'me',
    ['fields' => 'id,firstName,lastName']
);
print_r($profile);

列出您是管理员的公司

$profile = $client->get(
    'organizationalEntityAcls',
    ['q' => 'roleAssignee']
);
print_r($profile);

获取公司页面配置文件

$companyId = '123'; // use id of the company where you are an admin
$companyInfo = $client->get('organizations/' . $companyId);
print_r($companyInfo);

设置自定义API请求头

更改发送给LinkedIn API的不同头

$client->setApiHeaders([
  'Content-Type' => 'application/json',
  'x-li-format' => 'json',
  'X-Restli-Protocol-Version' => '2.0.0', // use protocol v2
  'x-li-src' => 'msdk' // set a src header to "msdk" to mimic a mobile SDK
]);

更改默认API根

一些私有API访问。

$client->setApiRoot('https://api.linkedin.com/v2/');