README

SDK PHP pour l'API BLUP de Beekube - Calcul génétique des abeilles mellifères

For more information, please visit https://www.beekube.com.

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

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

{
  "require": {
    "beekube-app/blup-php-sdk": "*"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

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

Getting Started

Please follow the installation procedure and then run the following:

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




$apiInstance = new Beekube\BlupSDK\Api\BlupApi(
    // 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()
);
$blupV2Input = new \Beekube\BlupSDK\Models\BlupV2Input(); // \Beekube\BlupSDK\Models\BlupV2Input

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

API Endpoints

All URIs are relative to https://mellifera.beekube.com

Class	Method	HTTP request	Description
BlupApi	blupV2Post	POST /v2/blup	Évaluation génétique v2 : index par critère, index total, accouplements suggérés.
BlupApi	calulateBlupPost	POST /blup	Perform BLUP calculation
BlupApi	matingV2Post	POST /v2/mating	Évalue des couples mère × source de mâles choisis (index attendu, consanguinité attendue).
BlupApi	welcomeGet	GET /	Welcome endpoint

Models

Authorization

All endpoints do not require authorization.

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

contact@beekube.com

About this package

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

API version: 2.0.0
- Package version: 2.0.0
- Generator version: 7.10.0
Build package: org.openapitools.codegen.languages.PhpNextgenClientCodegen

beekube-app / blup-php-sdk

Package info

Security

Statistics