LG WebAPI Documentation

Welcome to the LG WebAPI documentation! This is your comprehensive guide to integrating with the Property Management System (PMS) Web API.

What is PMS Web API?

The PMS Web API is a RESTful interface that enables external services and applications to integrate with the hotel management platform. It provides secure, scalable access to hotel operations, guest information, and real-time event notifications through webhooks.

Quick Start

New to the API? Follow these steps to get started:

  1. Get Your API Token - Contact your system administrator to obtain an authentication token for your service
  2. Explore the API - Use Swagger UI at {base-url}/swagger?token={your-token} to browse available endpoints
  3. Make Your First Call - Start with the /api/external-operations endpoint to see what operations are available to your service
  4. Read the Documentation - Review the Getting Started Guide for detailed instructions

Documentation Sections

📚 Introduction

Learn about the PMS Web API architecture, security features, and key capabilities. This section provides an overview of the system and helps you understand how it works.

🚀 Getting Started

Step-by-step guide to obtaining your API token, making your first API call, understanding access permissions, and setting up your integration. Perfect for developers who are new to the API.

🔔 Webhook Configuration

Comprehensive guide to setting up and using webhooks for real-time event notifications. Learn how to configure webhook endpoints, handle events, verify signatures, and troubleshoot common issues.

📖 API Reference

Complete API reference documentation generated from the source code. Browse all available endpoints, request/response models, and code examples.

Key Features

  • RESTful API - Standard HTTP methods and JSON payloads
  • Bearer Token Authentication - Secure, token-based authentication
  • Granular Permissions - Fine-grained access control at service and hotel levels
  • Webhook Support - Real-time event notifications with signature verification
  • Interactive Documentation - Swagger UI for testing and exploration
  • Comprehensive Error Handling - Clear error messages and status codes

Common Use Cases

  • Guest Management - Create, update, and retrieve guest profiles
  • Reservation Integration - Access reservation data and status updates
  • Event Notifications - Receive real-time notifications via webhooks
  • Dictionary Access - Retrieve reference data like salutations and titles
  • Custom Integrations - Build custom applications that interact with the PMS system

Need Help?

Next Steps

  1. Read the Introduction to understand the API architecture
  2. Follow the Getting Started Guide to obtain your token and make your first API call
  3. Explore the API Reference to discover available endpoints
  4. Set up Webhooks if you need real-time event notifications

Ready to start? Begin with the Getting Started Guide!