1. Default Module
YGO Client API
v1
  • v2
  • v1
  • Default Module
    • Overview
    • Core Concepts
    • Authentication
    • Quickstart Guide
    • AI Search & Trip Planning
    • Booking Flow
    • Environments
    • General
      • Check API health status
      • Get current API key context
    • AI Search & Trip Planning
      • Send message to YGO AI
    • Product Search (Deprecated)
      • Search for hotel & package offers
      • Get transfers for booking
      • Get package price calendar
    • Bookings
      • Get or create open booking
      • Check offer availability
      • Update open booking
      • Update booking status and trigger workflows
      • List bookings
      • Get booking
    • Schemas
      • Schemas
        • PackageSearchRequest
        • GetPackageCalendarRequest
        • GetBookingRequest
        • ListBookingsRequest
        • SaveBookingStatusRequest
        • SaveOpenBookingRequest
        • GetOpenBookingRequest
        • GetTransfersRequest
        • Product
        • Booking
        • TransferOptionsResponse
        • PackageCalendarResponse
        • ProductTexts
        • BookingDetails
        • TripReference
        • TransferOption
        • PackageCalendarDate
        • LocaleContent
        • BookingItemInput
        • Trip
        • ProductImage
        • TransferImage
        • BookingItem
        • Traveller
        • PickupInformation
        • ProductDetails
        • PackageOffer
        • PickupLocation
        • Image
        • Pickup
        • TourOperator
        • CheckPickup
        • Accommodation
        • TransferRemark
        • Room
        • CancellationPolicy
        • Transport
        • Flight
        • Airport
        • Price
        • PriceByPax
        • SuccessResponse
        • ErrorResponse
        • Hotel
        • HotelFeatures
        • FeatureState
        • RoomFeatures
        • RoomContent
        • Facility
      • Response
        • Unauthorized
  1. Default Module

Core Concepts

Before you start building with the YGO API, it's important to understand how we organize access and data through Organizations and Projects.

Organizations#

An Organization represents your company or business entity in the YGO platform. When you become a YGO partner, we create an Organization for you.
What an Organization includes:
Your company profile and contact information
Billing and contract details
One or more Projects (see below)
Team member access management
NOTE
Organizations are managed by the YGO team during onboarding. You don't need to create or configure your Organization through the API.

Projects#

A Project is your isolated workspace within the YGO API. Each Project acts as a separate tenant with its own:
API Keys - Unique credentials for authentication
Supplier Credentials - Your Peakwork, Amadeus, or other supplier connections
Booking Data - All bookings and transactions are scoped to a Project
Environment Type - Either sandbox (test data) or production (live bookings)

Why Projects?#

Projects give you flexibility to:
Separate environments - Keep test and production data isolated
Manage multiple brands - Run different brands or sales channels independently
Control team access - Grant different permissions per Project

Typical Setup#

Most partners start with this structure:
Your Organization
├── Sandbox Project (for development and testing)
└── Production Project (for live operations)
As your business grows, you can add more Production Projects for different brands, markets, or use cases.
TIP
During Onboarding: YGO creates your first Sandbox Project automatically. This includes test credentials for suppliers like Peakwork, so you can start integrating immediately without affecting live data.

Sandbox vs Production#

Sandbox Projects#

Purpose: Safe environment for development and testing
Supplier Credentials: Test/sandbox accounts from Peakwork, Amadeus, etc.
Bookings: Test bookings that won't be fulfilled
API Key: Connected to your Sandbox Project

Production Projects#

Purpose: Live operations with real customers
Supplier Credentials: Your production supplier accounts
Bookings: Real bookings that will be fulfilled and billed
API Key: Connected to your Production Project
WARNING
Always test your integration thoroughly in Sandbox before moving to Production. Bookings made in Production are real and will incur charges.

API Tokens and Projects#

Each API token belongs to a single Project. When you make an API request:
1.
You include your API token in the Authorization: Bearer header
2.
The API automatically routes to the correct environment and scopes all data to that Project
3.
You can only access bookings, searches, and data within that Project
If you need to access multiple Projects, you'll need separate API tokens for each.
TIP
Smart Routing: Your API token handles both authentication and environment routing. The same URL (https://api.ygo.ai/v1) works for all environments—the token determines where your request goes.
INFO
Need another Project? Contact your account manager to create additional Sandbox or Production Projects for your Organization.

Next Steps#

Now that you understand Organizations and Projects:
Learn how to authenticate with API tokens
Explore AI Search & Planning capabilities
Follow the Quickstart Guide to make your first request
Modified at 2025-10-18 07:05:54
Previous
Overview
Next
Authentication
Built with