README

PHP client for server-side integration with Stays API v1 (unofficial library)

Table of contents:

• Requirements
• Installation
• Getting started
• Setup
• Making Requests
• Using Responses
• Docs
• License
• Release History

Requirements

• PHP >= 7.3
• Composer

Installation

composer require robsonsanches/stays-php-client

Getting started

To obtain API credentials please read the Stays API Docs https://stays.net/external-api/#introduction.

Setup

Setup for the Stays API integration:

require '/vendor/autoload.php';

use RobsonSanches\Stays\Client\Client;

$stays = new Client($domain, $clientId, $clientSecret, $options);

Client Parameters

Additional options

Making Requests

You may use the get, post, patch, and delete methods to make requests to Stays API.

Request Methods

$stays->get($endpoint, $query = [], $headers = [])
$stays->post($endpoint, $data = [], $headers = [])
$stays->patch($endpoint, $data = [], $headers = [])
$stays->delete($endpoint, $query = [], $headers = [])

Arguments

Using Responses

All the request methods will return a response that can be a multidimensional array, array of objects or JSON string on success. If is present the argument http_errors = true, will throwing ClientException error on failure.

use RobsonSanches\Stays\Client\ClientException;

try {
    $results = $stays->get('content/groups');
    print_r( $results, true ); // array or JSON string

} catch (ClientException $e) {
    echo $e->getMessage(); // Exception message.
}

To get the response data from Http Client:

$response = $stays->http()->getResponse();

echo $response->getReasonPhrase(); // Reason phrase (string).
echo $response->getStatusCode(); // Response code (int).
echo $response->getBody()->getContents(); // Response body (JSON).

print_r( $response->getHeaders() ); // Response headers (array).
print_r( $response->getBody() ); // PSR-7 StreamInterface (object).

If you need to get the last requested data:

$request = $stays->http()->getRequest();

echo $request->getUri(); // Requested URI (string).
echo $request->getMethod(); // Request method (string).
echo $request->getBody()->getContents(); // Request body content (JSON).

print_r( $request->getHeaders() ); // Request headers (array).
print_r( $request->getUri() ); // PSR-7 UriInterface (object).
print_r( $request->getBody() ); // PSR-7 StreamInterface (object).

Docs

Stays Documentation

Licence

The MIT License

Release History

• 2022-02-20 - 1.0.0 - Initial release.