xrely/php-client

client library for xrely platform. For more information please visit https://www.xrely.com

1.0.0 2021-06-26 14:51 UTC

Requires

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

Requires (Dev)

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

proprietary

• team xrely

• Web search intelligence
• Autocrawl Search
• Intelligent search engine
• install site search
• Autocomplete search solution
• Search discovery

README

API Documentation for XRELY platform

• API version: 1.0.0

Requirements

PHP 5.5 and later

Installation & Usage

Composer

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

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/xrely-com/php_client.git"
    }
  ],
 "require": {
        "php": ">=5.5",
        "ext-curl": "*",
        "ext-json": "*",
        "ext-mbstring": "*",
        "guzzlehttp/guzzle": "^6.2"
    },
    "require-dev": {
        "phpunit/phpunit": "^4.8",
        "squizlabs/php_codesniffer": "~2.6",
        "friendsofphp/php-cs-fixer": "~2.12"
    }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

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

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

OR

 php vendor/phpunit/phpunit/phpunit

Getting Started

Please follow the installation procedure and then run the following:

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

$apiInstance = new Xrely\Client\Api\DataApi(
    // 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()
);
$body = new \Xrely\Client\Model\DataStoreRequest(); // \Xrely\Client\Model\DataStoreRequest | 

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

?>

Documentation for API Endpoints

All URIs are relative to https://www.xrely.com/api/v1

Class	Method	HTTP request	Description
DataApi	dataStoreDelete	DELETE /data/store	Delete data from your account bucket
DataApi	dataStorePost	POST /data/store	Insert data to your account bucket
SearchApi	searchPost	POST /search	Provides relevant result for your query
SearchApi	searchSuggestionsGet	GET /search/suggestions	Get autocomplete phrase or keywords for your query

Documentation For Models

• AggrigationField
• ApiResponse
• DataApiResponse
• DataMessage
• DataStoreRequest
• DocStoreItem
• FilterField
• MapObject
• SearchRequest

Documentation For Authorization

All endpoints do not require authorization.

Author

[e-mail]