README

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

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/LTD-Beget/openapi-auth-php.git"
    }
  ],
  "require": {
    "LTD-Beget/openapi-auth-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

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

Getting Started

Please follow the installation procedure and then run the following:

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



// Configure Bearer (JWT) authorization: bearerAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\AuthServiceApi(
    // 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
);
$auth_auth_request = new \OpenAPI\Client\Model\AuthAuthRequest(); // \OpenAPI\Client\Model\AuthAuthRequest

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

API Endpoints

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

Class	Method	HTTP request
AuthServiceApi	authServiceAuth	POST /v1/auth
AuthServiceApi	authServiceLogout	POST /v1/auth/logout
AuthServiceApi	authServiceRefreshToken	POST /v1/auth/refresh
AuthServiceApi	authServiceSwitchUser	POST /v1/auth/switch
KeyServiceApi	keyServiceGetKey	GET /v1/auth/key

Models

Authorization

bearerAuth

Type: Bearer authentication (JWT)

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

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

API version: v1.1.2
- Package version: v1.1.2
Build package: org.openapitools.codegen.languages.PhpClientCodegen

ltd-beget / openapi-auth-php

Maintainers

Details