AuthApi.md

Vgrish\YclientsOpenApi\AuthApi

All URIs are relative to https://api.yclients.com/api/v1, except if the operation defines another base path.

Method	HTTP request	Description
authUser()	POST /auth	Авторизовать пользователя

authUser()

authUser($accept, $content_type, $authorization, $auth_user_request): \Vgrish\YclientsOpenApi\Model\AuthUserResponse

Авторизовать пользователя

При смене пароля пользователем его API-ключ изменится и потребуется новая авторизация | Атрибут | Тип | Описание | | ------------- | ------------- | ------------- | | login | string | В качестве логина может быть использован номер телефона пользователя в формате 79161234567 или его Email | | password | string | Пароль пользователя |

Example

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



$apiInstance = new Vgrish\YclientsOpenApi\Api\AuthApi(
    // 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()
);
$accept = application/vnd.yclients.v2+json; // string | e.g. application/vnd.yclients.v2+json
$content_type = 'content_type_example'; // string | application/json
$authorization = Bearer {{partner_token}}; // string | Bearer partner_token
$auth_user_request = {"login":"{{login}}","password":"{{password}}"}; // \Vgrish\YclientsOpenApi\Model\AuthUserRequest

try {
    $result = $apiInstance->authUser($accept, $content_type, $authorization, $auth_user_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthApi->authUser: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
accept	string	e.g. application/vnd.yclients.v2+json
content_type	string	application/json
authorization	string	Bearer partner_token
auth_user_request	\Vgrish\YclientsOpenApi\Model\AuthUserRequest		[optional]

Return type

\Vgrish\YclientsOpenApi\Model\AuthUserResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]