AuthenticateApi.md

Reepay\AuthenticateApi

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

Method	HTTP request	Description
login	POST /v1/authenticate/login	User login
renew	POST /v1/authenticate/renew	Renew user login
verifyAuthentication	GET /v1/authenticate/verify	Verify authentication

login

\Reepay\Model\UserLogin login($email, $password, $organisation, $account)

User login

Example

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

$apiInstance = new Reepay\Api\AuthenticateApi();
$email = "email_example"; // string | User email
$password = "password_example"; // string | User password
$organisation = "organisation_example"; // string | Organisation subdomain to login to
$account = "account_example"; // string | Account handle or id to login to

try {
    $result = $apiInstance->login($email, $password, $organisation, $account);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticateApi->login: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
email	string	User email	[optional]
password	string	User password	[optional]
organisation	string	Organisation subdomain to login to	[optional]
account	string	Account handle or id to login to	[optional]

Return type

\Reepay\Model\UserLogin

Authorization

No authorization required

HTTP request headers

• Content-Type: application/x-www-form-urlencoded
• Accept: application/json

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

renew

\Reepay\Model\UserRenew renew()

Renew user login

Example

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

$apiInstance = new Reepay\Api\AuthenticateApi();

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

Parameters

This endpoint does not need any parameter.

Return type

\Reepay\Model\UserRenew

Authorization

No authorization required

HTTP request headers

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

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

verifyAuthentication

verifyAuthentication()

Verify authentication

Example

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

// Configure API key authorization: apiKey
Reepay\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Reepay\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure HTTP basic authorization: basicAuth
Reepay\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Reepay\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\AuthenticateApi();

try {
    $apiInstance->verifyAuthentication();
} catch (Exception $e) {
    echo 'Exception when calling AuthenticateApi->verifyAuthentication: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

apiKey, basicAuth

HTTP request headers

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

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