gridy-php-client

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/gridy.io/gridy-php-client.git"
    }
  ],
  "require": {
    "gridy.io/gridy": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/GridyAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

PHP

<?php

require_once(__DIR__ . '/vendor/autoload.php');

// Configure Your Gridy API User ID
$config = GridyAPI\Client\Configuration::getDefaultConfiguration()->setApiUser( 'YOUR_API_USER_ID');

// Configure Your Gridy API Secret Key
$config = GridyAPI\Client\Configuration::getDefaultConfiguration()->setApiUser( 'YOUR_API_SECRET_KEY');


$apiInstance = new GridyAPI\Client\Service\GridyIDServiceApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$api_request = { 
 "id":< Your own reference >,
 "utctime": <UTC Timestamp>,
 "apiUser":< Your Api User ID >,
 "type":150,
 "body":{
   "gridyUser":"<User Email Address>",
   "challengeType":<"UserKeyAndPattern"|"UserKeyPatternAndPin"|"UserKeyAndUserPin"|"UserKeyAndUserFace"|"UserKeyAndUserVoice" >,
   "challengeExpiry":<"ThreeMins"|"FiveMins"|"TenMins"|"FifteenMins"|"ThirtyMins"|"SixtyMins">,
   "enableQRCode":<true|false>,
   "enableAutoVerify":<true|false>,
   "profile":"<Your Assigned User Profile Reference>",
   "status":"NEW"
 }
}; // \GridyAPI\Client\Model\ApiRequest | The JSON body of the request. Contains the Gridy ID challenge request.

try {
    $result = $apiInstance->challenge($api_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GridyIDServiceApi->challenge: ', $e->getMessage(), PHP_EOL;
}

Documentation & Examples for API Endpoints

All URIs are relative to https://api.gridy.io

Class	Method	HTTP request	Description
GridyIdServiceApi	challenge	POST /v1/svc/challenge	Send or Cancel a Gridy ID MFA challenge request.
GridyIdServiceApi	verify	POST /v1/svc/verify	Verify a Gridy ID authentication code
GridyIdServiceApi	status	POST /v1/svc/status	Check a Gridy ID MFA challenge status
GridyIdServiceApi	time	POST /v1/svc/time	Get current UTC time
GridyIdServiceApi	blocked	POST /v1/svc/blocked	Check API User defined Blocked Rule

Tests

To run the tests, use:

composer install
vendor/bin/phpunit