README

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

For more information, please visit https://www.harness.io.

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/harness/ff-php-client-api.git"
    }
  ],
  "require": {
    "harness/ff-php-client-api": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

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

Getting Started

Please follow the installation procedure and then run the following:

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




$apiInstance = new OpenAPI\Client\Api\ClientApi(
    // 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()
);
$authentication_request = new \OpenAPI\Client\Model\AuthenticationRequest(); // \OpenAPI\Client\Model\AuthenticationRequest

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

API Endpoints

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

Class	Method	HTTP request	Description
ClientApi	authenticate	POST /client/auth	Authenticate with the admin server.
ClientApi	getAllSegments	GET /client/env/{environmentUUID}/target-segments	Retrieve all segments.
ClientApi	getEvaluationByIdentifier	GET /client/env/{environmentUUID}/target/{target}/evaluations/{feature}	Get feature evaluations for target
ClientApi	getEvaluations	GET /client/env/{environmentUUID}/target/{target}/evaluations	Get feature evaluations for target
ClientApi	getFeatureConfig	GET /client/env/{environmentUUID}/feature-configs	Get all feature flags activations
ClientApi	getFeatureConfigByIdentifier	GET /client/env/{environmentUUID}/feature-configs/{identifier}	Get feature config
ClientApi	getSegmentByIdentifier	GET /client/env/{environmentUUID}/target-segments/{identifier}	Retrieve a segment by identifier
ClientApi	stream	GET /stream	Stream endpoint.
MetricsApi	postMetrics	POST /metrics/{environment}	Send metrics to the Analytics server.

Models

Authorization

ApiKeyAuth

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

BearerAuth

Type: Bearer authentication (JWT)

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

cf@harness.io

About this package

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

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

harness / ff-php-client-api

Maintainers

Details