Download the PHP package vadimushka/ok-php-sdk without Composer
On this page you can find all versions of the php package vadimushka/ok-php-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download vadimushka/ok-php-sdk
More information about vadimushka/ok-php-sdk
Files in vadimushka/ok-php-sdk
Package ok-php-sdk
Short Description OK PHP SDK
License MIT
Homepage https://github.com/Vadimushka/ok-php-sdk
Informations about the package ok-php-sdk
ok-php-sdk
PHP library for Ok API interaction, includes OAuth 2.0 authorization and API methods. Full Ok API features documentation can be found here.
1. Prerequisites
- PHP 8.0 or later
2. Installation
The Ok PHP SDK can be installed using Composer by running the following command:
3. Initialization
Create OkApiClient object using the following code:
4. Authorization
The library provides the authorization flows for user based on OAuth 2.0 protocol implementation in apiok.ru. Please read the full documentation before you start.
4.1. Server Authorization Code Flow
OAuth 2.0 Authorization Code Flow allows calling methods from the server side.
This flow includes two steps — obtaining an authorization code and exchanging the code for an access token. Primarily you should obtain the "code" (manual user access) by redirecting the user to the authorization page using the following method:
Create OKOAuth
object first:
After successful authorization user's browser will be redirected to the specified redirect_uri. Meanwhile the code will be sent as a GET parameter to the specified address:
Then use this method to get the access token:
The redirect_uri should be the URL that was used to get a code at the first step.
4.2. Client Authorization Code Flow
In difference with server authorization code flow this flow gives you temporary access key.
Read more about user access key.
First step to get access using Implicit flow is creating OKOAuth object:
Arguments are similar with server authorization code flow
After successful authorization user's browser will be redirected to the specified redirect_uri. Meanwhile, the access token will be sent as a fragment parameter to the specified address:
access_token is your new access token. session_secret_key is secret session key. expires_in is lifetime of access token in seconds. permissions_granted is rights granted by the user to the application. state is string from authorize method.
5. API Requests
You can find the full list of OK API methods here.