s-anasol/vk

The PHP class for vk.com API. With HTTP proxy and captcha recognition via antigate support

VK API Wrapper

The PHP class for vk.com API and OAuth., _(*1)

Features: HTTP proxy, captcha recognition via antigate, api response timeout limit, _(*2)

Use

1. Install via composer, _(*3)

   composer require s-anasol/vk

2. Create VK object, _(*4)

   1. without authorization, _(*5)

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

   2. with authorization, _(*6)

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

3. If need authorization, _(*7)

   1. Get authoriz link, _(*8)

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

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

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

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

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

4. Usage API, _(*11)

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

5. Captcha recognition, _(*12)

   $vk->setAntigate('antigate-key');
   $vk->setCaptchaSavePath('./captcha'); // YOU MUST create 'captcha' folder at project root path
   

Class methods

• $vk->setApiVersion({NUBMER}); - set api version
• $vk->setProxy("1.2.3.4:8080"); - set HTTP proxy for API requests
• $vk->setTimeout(10); - set API Response timeout
• $vk->setAntigate("antigate-key"); - set antigate API key to resolve captcha
• $vk->setCaptchaSavePath("/tmp"); - set temporary captcha image save path

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}., _(*13)

License

MIT, _(*14)