mkopus/riskscreen-php-sdk

PHP SDK for riskscreen service

v1.1 2018-02-01 13:07 UTC

Requires

• php: >=5.5
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^6.2

Requires (Dev)

• friendsofphp/php-cs-fixer: ~1.12
• phpunit/phpunit: ^4.8
• squizlabs/php_codesniffer: ~2.6

MIT

• Swagger and contributors

• php
• api
• sdk
• swagger

README

SwaggerClient-php

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

This PHP package is automatically generated by the Swagger Codegen project:

• API version: v1
• Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.4.0 and later

Installation & Usage

Composer

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

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

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/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: APIKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$api_instance = new Swagger\Client\Api\ResultsApi();
$encoded_id = "encoded_id_example"; // string | 

try {
    $result = $api_instance->resultsGetCompanyDetails($encoded_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResultsApi->resultsGetCompanyDetails: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://api.riskscreen.com

Class	Method	HTTP request	Description
ResultsApi	resultsGetCompanyDetails	GET /api/v1/results/company/{encodedId}
ResultsApi	resultsGetPersonDetails	GET /api/v1/results/person/{encodedId}
SearchApi	searchCompany	POST /api/v1/search/bycompany
SearchApi	searchPerson	POST /api/v1/search/byperson
UserApi	userCurrentUser	POST /api/v1/user/currentuser
UserApi	userTokenQuery	POST /api/v1/user/tokens

Documentation For Models

• SpDATSEARCHFETC0CompanyResult
• SpDATSEARCHFETC0PersonResult
• WebSearchCompany
• WebSearchPerson

Documentation For Authorization

APIKeyHeader

• Type: API key
• API key parameter name: api-key
• Location: HTTP header

Author