Introduction
Welcome to the City Connect integration guide. Here you'll find information for both supplying products to be sold (Supplier Guide) as well as selling products (Agent Guide).
Although we differentiate the two guides in the documentation, a single account can be both an Agent (sell tickets) and Supplier (supply / redeem tickets). Depending on your use case you may wish to integrate both guides or just one.
Before you do either though, you must understand how City Connect structures product inventory, and more importantly, what our terminology is so you can map this to your own system.
Below is a table of the core core concepts and terminology that you must familiarise yourself with before proceeding with the documentation.
| Field | Description | Example |
|---|---|---|
| Agent | The account making the booking. | Viator |
| Supplier | The account receiving and later redeeming that booking. | The Vatican Museum |
| Account | An account is just an entity that holds many products, it can act as both an agent or a supplier. | |
| Product | The parent tour, venue, or sale object. | - Romantic Sunset Tour - The Vatican Museum - Berlin Bus Tours |
| Options | Variations or sub-products within the product. | - 1 Day Tour - 2 Day Tour - 3 Day Tour |
| Times | A departure time for a tour, or show time for a play, etc. | - 10:30 - 12:30 - 14:30 |
| Opening Hours | If the product has no specific times, and instead has generic opening times. | - From: 10:30 To: 12:00 - From: 14:00 To: 18:00 |
| Pickup | A hotel or pickup location for products that provide pickups. | Bay Hotel at 09:12 |
| Booking | A booking for a product (and option) that contains multiple tickets. | |
| Ticket | An adult / child / senior etc. ticket within the booking. | |
| Customer | The original customer who made the booking. | John Smith [email protected] |
| Redemption | Redemption is the equivalent of "check-in" in airline terminology. Once redeemed the booking is considered used and can be invoiced for. | |
| Freesale | A booking made without checking availability and which only becomes visible to the supplier upon redemption. | |
| RRP | "Recommended Retail Price" The suggested price of the ticket by the supplier. | 10.00 USD |
| NET | The net rate the supplier will charge the agent for the ticket. | 6.00 USD |
City Connect is a two way API that provides endpoints which you can make requests too, but it also requires you implement endpoints within your system which respond in a defined way which City Connect can make requests too.
To make it easier we differentiate between the two using arrow symbols:
⇡ (up arrow) marks an endpoint that you call on api.cityconnect.net
⇣ (down arrow) marks an endpoint that you must implement on your server that City Connect can request.
Updated about 8 years ago