vladkens/vk

The PHP class for vk.com API with support OAuth.

VK

По-русски

Класс реализует VK API и авторизацию по OAuth протоколу. По всем вопросам можно писать на vladkens@yandex.ru, _(*1)

Использование

1. Подключите класс, _(*2)

   require('VK.php');

2. Создайте объект VK, _(*3)

   1. без авторизации, _(*4)

      $vk = new VK\VK('{APP_ID}', '{API_SECRET}');

   2. с авторизацией, _(*5)

      $vk = new VK\VK('{APP_ID}', '{API_SECRET}', '{ACCESS_TOKEN}');

3. Если нужна авторизация, _(*6)

   1. Получаем ссылку авторизации, _(*7)

      $vk->getAuthorizeURL('{API_SETTINGS}', '{CALLBACK_URL}');

   2. Получаем токен доступа по ключу из ссылки авторизации, _(*8)

      $vk->getAccessToken('{CODE}');

   3. Проверить авторизирован ли пользователь, _(*9)

      $vk->isAuth(); // return bool

4. Используем API, _(*10)

   $vk->api('{METHOD_NAME}', '{PARAMETERS}');

Другие методы

• Установить версию API. $vk->setApiVersion({NUBMER});

Переменные

• {APP_ID} — ID приложения вконтакте.
• {API_SECRET} — Секретный код приложения.
• {ACCESS_TOKEN} — Токен доступа.
• {API_SETTINGS} — Запрашиваемые права доступа приложения (через запятую).
• {CALLBACK_URL} — Адрес, на который будет передан {CODE}.
• {CODE} — Код для получения токена доступа.
• {METHOD_NAME} — Имя API метода. Все методы.
• {PARAMETERS} — Параметры соответствующего метода API.

* Если нужно получить бесконечный токен, используете параметр offline в {API_SETTINGS}., _(*11)

Лицензия

MIT, _(*12)

English

The PHP class for vk.com API and to support OAuth. You can ask me any questions by e-mail: vladkens@yandex.ru, _(*13)

Use

1. Connect class, _(*14)

   require('VK.php');

2. Create VK object, _(*15)

   1. without authorization, _(*16)

      $vk = new VK\VK('{APP_ID}', '{API_SECRET}');

   2. with authorization, _(*17)

      $vk = new VK\VK('{APP_ID}', '{API_SECRET}', '{ACCESS_TOKEN}');

3. If need authorization, _(*18)

   1. Get authoriz link, _(*19)

      $vk->getAuthorizeURL('{API_SETTINGS}', '{CALLBACK_URL}');

   2. Get the token access by code from the authoriz link, _(*20)

      $vk->getAccessToken('{CODE}');

   3. Check the status of authorization, _(*21)

      $vk->isAuth(); // return bool

4. Usage API, _(*22)

   $vk->api('{METHOD_NAME}', '{PARAMETERS}');

Other methods

• Set version of API. $vk->setApiVersion({NUBMER});

Variables

• {APP_ID} — Your application's identifier.
• {API_SECRET} — Secret application key.
• {ACCESS_TOKEN} — Access token.
• {API_SETTINGS} — Access rights requested by your app (through comma).
• {CALLBACK_URL} — Address to which {CODE} will be rendered.
• {CODE} — The code to get access token.
• {METHOD_NAME} — Name of the API method. All methods.
• {PARAMETERS} — Parameters of the corresponding API methods.

* If you need infinite token use key offline in {API_SETTINGS}., _(*23)

License

MIT, _(*24)