Overview

Namespaces

  • LoginRadiusSDK
    • Advance
    • Clients
    • CustomerRegistration
      • Account
      • Authentication
      • Social
    • Utility

Classes

  • LoginRadiusSDK\Advance\ConfigAPI
  • LoginRadiusSDK\Advance\WebHooksAPI
  • LoginRadiusSDK\Clients\DefaultHttpClient
  • LoginRadiusSDK\CustomerRegistration\Account\AccountAPI
  • LoginRadiusSDK\CustomerRegistration\Account\CustomObjectAPI
  • LoginRadiusSDK\CustomerRegistration\Account\CustomRegistrationDataAPI
  • LoginRadiusSDK\CustomerRegistration\Account\RoleAPI
  • LoginRadiusSDK\CustomerRegistration\Authentication\AuthCustomObjectAPI
  • LoginRadiusSDK\CustomerRegistration\Authentication\UserAPI
  • LoginRadiusSDK\CustomerRegistration\Social\AdvanceSocialLoginAPI
  • LoginRadiusSDK\CustomerRegistration\Social\SocialLoginAPI
  • LoginRadiusSDK\Utility\Functions

Interfaces

  • LoginRadiusSDK\Clients\IHttpClient

Exceptions

  • LoginRadiusSDK\LoginRadiusException
  • Overview
  • Namespace
  • Class
 1:  2:  3:  4:  5:  6:  7:  8:  9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 91: 
<?php
/**
 * @link                : http://www.loginradius.com
 * @category            : Advance
 * @package             : WebHooksAPI
 * @author              : LoginRadius Team
 * @license             : https://opensource.org/licenses/MIT
 */

namespace LoginRadiusSDK\Advance;

use LoginRadiusSDK\Utility\Functions;

/**
 * Class WebHooksAPI
 *
 * This is the main class to communicate with Webhook APIs.
 */
class WebHooksAPI
{
    /**
     * 
     * @param type $apikey
     * @param type $apisecret
     * @param type $options
     */
    public function __construct($apikey = '', $apisecret = '', $options = array())
    {
        new Functions($apikey, $apisecret, $options);
    }

    
    
    /**
     * Test WebHooks settings on your LoginRadius site.
     * @return type
     */
    public function webHooksSettings()
    {
        return $this->apiClientHandler('webhook/test', array());
    }
    
     /**
     * This API allow you to subscribe WebHook on your LoginRadius site.
     *
     * @param $target_url //URL where trigger will send data when it invoke
     * @param $event //Name of event, Login, Register, UpdateProfile, ResetPassword, ChangePassword, emailVerification, AddEmail, RemoveEmail, BlockAccount, DeleteAccount, SetUsername, CreateTraditionalAccount, AssignRoles, UnassignRoles, SetPassword, LinkAccount, UnlinkAccount, UpdatePhoneId, VerifyPhoneNumber
     * @return type
     */
    public function subscribeWebHooks($target_url, $event = 'Login')
    {
        return $this->apiClientHandler('webhook', array(), array('method' => 'POST', 'post_data' => array('TargetUrl' => $target_url, 'Event' => $event), 'content_type' => 'json'));
    }
    

    /**
     * This API retrieves all of the Urls subscribed to a given WebHook event
     *
     * @param string $event
     * @return type
     */
    public function getWebHooksSubscribedUrls($event = 'Login')
    {
        return $this->apiClientHandler('webhook', array('event' => $event));
    }
   

    /**
     * This API allow you to unsubscribe WebHook on your LoginRadius site.
     *
     * @param $target_url //URL where trigger will send data when it invoke
     * @return type 
     */
    public function unsubscribeWebHooks($target_url, $event = 'Login')
    {
        return $this->apiClientHandler('webhook', array(), array('method' => 'DELETE', 'post_data' => array('TargetUrl' => $target_url, 'Event' => $event), 'content_type' => 'json'));
    }

    /**
     *
     * @param type $path
     * @param type $query_array
     * @param type $options
     * @return type
     */
    private function apiClientHandler($path, $query_array = array(), $options = array())
    {
        return Functions::apiClient("/api/v2/" . $path, $query_array, array_merge(array('authentication' => 'secretparams'), $options));
    }
}
API documentation generated by ApiGen