Skip to content

Commit 6496c83

Browse files
committed
Add Russian Readme
1 parent ef8e244 commit 6496c83

File tree

1 file changed

+181
-0
lines changed

1 file changed

+181
-0
lines changed

README.ru.md

Lines changed: 181 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,181 @@
1+
Клиент для работы с LinkedIn API с авторизацией через OAuth 2 написанный на PHP
2+
============================================================
3+
[![Build Status](https://travis-ci.org/zoonman/linkedin-api-php-client.svg?branch=master)](https://travis-ci.org/zoonman/linkedin-api-php-client) [![Code Climate](https://codeclimate.com/github/zoonman/linkedin-api-php-client/badges/gpa.svg)](https://codeclimate.com/github/zoonman/linkedin-api-php-client) [![Packagist](https://img.shields.io/packagist/dt/zoonman/linkedin-api-php-client.svg)](https://packagist.org/packages/zoonman/linkedin-api-php-client) [![GitHub license](https://img.shields.io/github/license/zoonman/linkedin-api-php-client.svg)](https://github.com/zoonman/linkedin-api-php-client/blob/master/LICENSE.md)
4+
5+
6+
7+
Чтобы быстрее вникнуть, смотри [пример использования](examples/) внутри [index.php](examples/index.php).
8+
9+
10+
## Установка
11+
12+
Установка делается через composer следующей командой
13+
14+
```bash
15+
composer require zoonman/linkedin-api-php-client
16+
```
17+
18+
Также можно добавить `composer.json`.
19+
20+
Если вы никогда им не пользовались, познакомьтесь на [этой страничке](http://www.phptherightway.com/#composer_and_packagist)
21+
и установите composer.
22+
23+
24+
## Использование клиента
25+
26+
Чтобы начать работать с LinkedIn API, потребуется раздобыть идентификатор клиента (client id) и его секретный ключ (secret).
27+
28+
Получить их можно на [Портале разработчиков](https://developer.linkedin.com/), для этого зайдите в секцию мои приложения
29+
(My Apps).
30+
31+
32+
#### Подключение к проекту
33+
34+
Установите пакет, там появится каталог vendor, в котором будет autoload.php - это автозагрузчик.
35+
36+
```php
37+
// ... подлкючить автозагрузчик
38+
include_once __DIR__ . DIRECTORY_SEPARATOR . 'vendor' . DIRECTORY_SEPARATOR . 'autoload.php';
39+
40+
// сделать класс доступным
41+
use LinkedIn\Client;
42+
43+
// создать новый объект
44+
$client = new Client(
45+
'LINKEDIN_APP_CLIENT_ID',
46+
'LINKEDIN_APP_CLIENT_SECRET'
47+
);
48+
```
49+
50+
#### Получение локального адреса для перенаправления
51+
52+
Чтобы начать процесс аутентификации вам необходимо установить адрес для перенаправления.
53+
Вы можете вызвать метод `getRedirectUrl()`,
54+
55+
```php
56+
$redirectUrl = $client->getRedirectUrl();
57+
```
58+
59+
Вам нужно будет сохранить этот адрес во временное хранилище для текущей сессии.
60+
Вам потребуется этот адрес снова, когда вы будете получать токен.
61+
62+
```php
63+
$_SESSION['linkedin_redirect_url'] = $redirectUrl;
64+
```
65+
66+
#### Установка собственного адреса возврата
67+
68+
Вы также можете использовать `setRedirectUrl()`, чтобы установить свой обратный адрес.
69+
Не забудьте указать этот адрес в параметрах приложения.
70+
71+
```php
72+
$client->setRedirectUrl('http://your.domain.tld/path/to/script/');
73+
```
74+
75+
#### Получение адреса для аутентификации
76+
77+
Для того, чтобы пройти аутентификацию, вам необходимо получить адрес в LinkedIn,
78+
на который нужно перенаправить пользователя.
79+
Этот тот самый адрес, на котором пользователя спрашивают о подтвердении
80+
запрашиваемых прав доступа для приложения.
81+
82+
```php
83+
// определить области доступа
84+
$scopes = [
85+
'r_basicprofile',
86+
'r_emailaddress',
87+
'rw_company_admin',
88+
'w_share',
89+
];
90+
$loginUrl = $client->getLoginUrl($scopes); // получить адрес
91+
```
92+
93+
Теперь нужно перенаправить пользователя на полученный адрес.
94+
95+
96+
#### Получение токена
97+
98+
Чтобы получить токен или маркер доступа, как его иногда называют,
99+
нужно установить обратный адрес ($redirectUrl), который вы сохранили в сессии.
100+
101+
А затем вызвать получение токена
102+
103+
```php
104+
$accessToken = $client->getAccessToken($_GET['code']);
105+
```
106+
107+
#### Вызов API
108+
109+
All API calls can be called through simple method:
110+
Вызовы API происходят с помощью простого метода api(),
111+
который принимает 3 параметра: путь вызова, параметры и метод.
112+
113+
```php
114+
$profile = $client->api(
115+
'ENDPOINT',
116+
['parameter name' => 'its value here'],
117+
'HTTP method like GET for example'
118+
);
119+
```
120+
121+
Есть два упрощенных вызова:
122+
123+
```php
124+
// метод get
125+
$client->get('путь', ['имя параметра' => 'значение']);
126+
127+
// метод post
128+
$client->post('ENDPOINT', ['param' => 'value']);
129+
```
130+
#### Примеры
131+
132+
Получить информацию о профиле
133+
134+
```php
135+
$profile = $client->get(
136+
'people/~:(id,email-address,first-name,last-name)'
137+
);
138+
print_r($profile);
139+
```
140+
141+
Получить список компаний, в которой владелец токена - администратор.
142+
143+
```php
144+
$profile = $client->get(
145+
'companies',
146+
['is-company-admin' => true]
147+
);
148+
print_r($profile);
149+
```
150+
151+
Опубликовать сообщение у себя на странице профиля
152+
153+
```php
154+
$share = $client->post(
155+
'people/~/shares',
156+
[
157+
'comment' => 'Посмотри, какая классная библиотека для работы с LinkedIn!',
158+
'content' => [
159+
'title' => 'PHP Client for LinkedIn API',
160+
'description' => 'OAuth 2 flow, composer Package',
161+
'submitted-url' => 'https://github.com/zoonman/linkedin-api-php-client',
162+
'submitted-image-url' => 'https://github.com/fluidicon.png',
163+
],
164+
'visibility' => [
165+
'code' => 'anyone'
166+
]
167+
]
168+
);
169+
```
170+
171+
172+
## Помощь проекту
173+
174+
Если вы нашли ошибку и исправили ее, вы всегда можете открыть Pull Request.
175+
У нас есть небольшое требование к качеству кода.
176+
Пожалуйста, следуйте стандарту [PSR](http://www.php-fig.org/psr/) и пишите тесты PHPUnit для вносимых изменений.
177+
178+
## Лицензия
179+
180+
[MIT](LICENSE.md) - вы имеете право использовать библиотеку без каких-либо отчислений.
181+
Пожалуйста, указывайте ссылку на данный проекта в своих приложениях.

0 commit comments

Comments
 (0)