README

A Laravel package for integrating with the Russian Tourism API (tourism.fsa.gov.ru) to access hotels, resorts, and destinations data.

Features

🏨 Hotels API - Access hotel data from Russian Tourism API
🏖️ Resorts API - Get resort information and details
🗺️ Destinations API - Retrieve destination data
🔄 Retry Logic - Automatic retry on API failures
⚡ Performance - Optimized HTTP requests with timeout handling
🛡️ Error Handling - Comprehensive error handling and logging

Requirements

PHP 8.2+
Laravel 12.0+

Installation

Via Composer

composer require nakipelo/tourism-api

Manual Installation

Clone the repository:

git clone https://github.com/nakipelo/tourism-api.git

Install dependencies:

composer install

Publish the configuration:

php artisan vendor:publish --tag=tourism-api

Configuration

The package configuration file will be published to config/tourism-api.php. You can modify the following settings:

return [
    'base_url' => env('TOURISM_API_BASE_URL', 'https://tourism.fsa.gov.ru'),
    'api_version' => env('TOURISM_API_VERSION', 'v1'),
    'timeout' => env('TOURISM_API_TIMEOUT', 30),
    'retry_attempts' => env('TOURISM_API_RETRY_ATTEMPTS', 3),
    
    'user_agent' => env('TOURISM_API_USER_AGENT', 'Nakipelo-Tourism-API/1.0'),
    'endpoints' => [
        'hotels' => '/ru/resorts/showcase/hotels',
        'resorts' => '/ru/resorts',
        'destinations' => '/ru/destinations',
    ],
];

Usage

API Integration

The package integrates with the following Russian Tourism API endpoints:

Hotels Showcase: /api/v1/resorts/hotels/showcase - Get paginated list of hotels
Hotel Main Info: /api/v1/resorts/hotels/{id}/main - Get detailed hotel information
Hotel Additional Info: /api/v1/resorts/common/{id}/additional-info - Get additional hotel details
Hotel Drawer: /api/v1/resorts/hotels/{id}/drawer - Get hotel drawer information

Reference Data

Regions: /api/v1/nsi/regions/get - Get regions list
Hotel Statuses: /api/v1/nsi/hotelStatus/get - Get hotel status types
Hotel Types: /api/v1/nsi/hotelTypes/get - Get hotel type categories
Room Categories: /api/v1/nsi/roomCategory/get - Get room category types
Hotel Services: /api/v1/resorts/filter/services/hotelServices - Get available hotel services

Service Usage

use Nakipelo\TourismApi\Services\TourismApiService;

// Get hotels showcase with pagination
$hotels = app(TourismApiService::class)->getHotelsShowcase([
    'page' => 0,
    'limit' => 20
]);

// Get specific hotel details
$hotel = app(TourismApiService::class)->getHotelMain('c02d00bf-c607-11ef-92da-8ba33c42ca02');

// Get hotel additional info
$additionalInfo = app(TourismApiService::class)->getHotelAdditionalInfo('c02d00bf-c607-11ef-92da-8ba33c42ca02');

// Get reference data
$regions = app(TourismApiService::class)->getRegions();
$hotelTypes = app(TourismApiService::class)->getHotelTypes();
$roomCategories = app(TourismApiService::class)->getRoomCategories();

Testing

Run the test suite:

composer test

Contributing

Fork the repository
Create a feature branch (git checkout -b feature/amazing-feature)
Commit your changes (git commit -m 'Add some amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

License

This package is open-sourced software licensed under the MIT license.

Support

If you encounter any issues or have questions, please open an issue on GitHub.

Changelog

Please see CHANGELOG for more information on what has changed recently.

nakipelo / tourism-api

Maintainers

Details