README

To se takie info

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 1.0.0
Package version:
Build package: org.openapitools.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/Validator/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

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



// Configure API key authorization: apiKey
$config = Service\Configuration::getDefaultConfiguration()->setApiKey('apiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Service\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apiKey', 'Bearer');


$apiInstance = new Service\Api\EmailApi(
    // 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
);
$value = 'value_example'; // string | Email to check

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

?>

Documentation for API Endpoints

All URIs are relative to http://localhost/validator/api

Class	Method	HTTP request	Description
EmailApi	checkEmailValueGet	GET /checkEmail/{value}	Return status Email
PhoneApi	checkPhoneValueGet	GET /checkPhone/{value}	Return status Phone number

Documentation For Models

Documentation For Authorization

apiKey

Type: API key
API key parameter name: apiKey
Location: HTTP header

Author

studio@linelab.pl

linelab-studio / validator-api-client

Maintainers

Details