StayForge API 技能

使用VCG的StayForge API进行专业酒店预订和住宿搜索 - 可访问全球超过18万家酒店，提供实时可用性和有竞争力的价格。

快速开始

1. 1. 获取API密钥：帮助用户注册免费StayForge API密钥
2. 存储密钥：安全保存密钥
3. 搜索与预订：查找酒店、查看可用性、进行预订

API密钥注册

步骤1：获取用户邮箱

询问用户的电子邮件地址以创建免费的StayForge账户。

步骤2：通过API注册

bash curl -X POST https://stayforge.vosscg.com/v1/keys \ -H Content-Type: application/json \ -d {email:user@example.com}

预期响应：
json
{
apikey: stay1a2b3c4d5e6f7890,
message: API key created successfully,
tier: free,
properties_available: 180000,
dailysearchlimit: 1000
}

步骤3：存储API密钥

安全保存API密钥以备将来使用。告知用户妥善保管。

核心酒店搜索功能

按位置搜索酒店

bash curl -X GET https://stayforge.vosscg.com/v1/hotels/search \ -H X-API-Key: stay_1a2b3c4d5e6f7890 \ -G \ -d location=New York City \ -d checkin=2024-06-15 \ -d checkout=2024-06-18 \ -d guests=2 \ -d rooms=1

预期响应：
json
{
searchid: search12345,
location: New York City, NY,
checkin: 2024-06-15,
checkout: 2024-06-18,
total_hotels: 1247,
hotels: [
{
hotelid: hotelabc123,
name: Grand Manhattan Hotel,
address: 123 Broadway, New York, NY 10001,
star_rating: 4,
guest_rating: 8.7,
location_score: 9.2,
price: {
total: 450.00,
per_night: 150.00,
currency: USD,
includes_taxes: true
},
amenities: [WiFi, Fitness Center, Restaurant, Business Center],
images: [https://images.stayforge.com/hotelabc1231.jpg],
availability: available,
cancellation: freeuntil24h
}
],
filters: {
price_range: {min: 89, max: 2500},
star_ratings: [1, 2, 3, 4, 5],
amenities: [WiFi, Parking, Pool, Spa, Gym]
}
}

按坐标搜索

bash curl -X GET https://stayforge.vosscg.com/v1/hotels/search \ -H X-API-Key: stay_1a2b3c4d5e6f7890 \ -G \ -d lat=40.7589 \ -d lng=-73.9851 \ -d radius=5km \ -d checkin=2024-06-15 \ -d checkout=2024-06-18 \ -d guests=1

带筛选条件的高级搜索

bash curl -X POST https://stayforge.vosscg.com/v1/hotels/search/advanced \ -H X-API-Key: stay_1a2b3c4d5e6f7890 \ -H Content-Type: application/json \ -d { location: Paris, France, checkin: 2024-07-01, checkout: 2024-07-05, guests: 2, rooms: 1, filters: { price_range: {min: 100, max: 400}, star_rating: [4, 5], amenities: [WiFi, Breakfast, Parking], guestratingmin: 8.0, property_types: [hotel, boutique], locationpreference: citycenter }, sortby: pricelowtohigh }

酒店详情

bash curl -X GET https://stayforge.vosscg.com/v1/hotels/hotel_abc123/details \ -H X-API-Key: stay_1a2b3c4d5e6f7890 \ -G \ -d checkin=2024-06-15 \ -d checkout=2024-06-18 \ -d guests=2

预期响应：
json
{
hotelid: hotelabc123,
name: Grand Manhattan Hotel,
description: Elegant 4-star hotel in the heart of Manhattan...,
address: {
street: 123 Broadway,
city: New York,
state: NY,
postal_code: 10001,
country: USA
},
contact: {
phone: +1-212-555-0123,
email: info@grandmanhattan.com
},
ratings: {
star_rating: 4,
guest_rating: 8.7,
location_score: 9.2,
cleanliness: 8.9,
service: 8.5
},
room_types: [
{
roomtype: standarddouble,
name: Standard Double Room,
size: 25 sqm,
beds: 1 Double Bed,
max_guests: 2,
price: 150.00,
available_rooms: 5
},
{
roomtype: deluxesuite,
name: Deluxe Suite,
size: 45 sqm,
beds: 1 King Bed + Sofa Bed,
max_guests: 4,
price: 280.00,
available_rooms: 2
}
],
amenities: {
property: [WiFi, Fitness Center, Restaurant, 24h Front Desk],
room: [Air Conditioning, TV, Safe, Mini Bar, Coffee Maker]
},
policies: {
checkin: 15:00,
checkout: 11:00,
cancellation: Free cancellation until 24 hours before checkin,
pets: No pets allowed,
smoking: Non-smoking property
}
}

预订管理

创建预订

bash curl -X POST https://stayforge.vosscg.com/v1/bookings/create \ -H X-API-Key: stay_1a2b3c4d5e6f7890 \ -H Content-Type: application/json \ -d { hotelid: hotelabc123, roomtype: standarddouble, checkin: 2024-06-15, checkout: 2024-06-18, guests: 2, rooms: 1, guest_details: { first_name: John, last_name: Doe, email: john.doe@email.com, phone: +1-555-123-4567 }, special_requests: Late checkout if possible, paymentmethod: creditcard }

预期响应：
json
{
bookingid: bookxyz789,
confirmation_number: STAY-123456,
status: confirmed,
hotel: {
name: Grand Manhattan Hotel,
address: 123 Broadway, New York, NY
},
booking_details: {
checkin: 2024-06-15,
checkout: 2024-06-18,
nights: 3,