Debes crear un servidor de reservas a fin de permitir que el Centro de acciones realice devoluciones de llamada para crear y actualizar reservas en tu nombre.
- Implementación estándar. Esto permite que el Centro de acciones cree citas y reservas contigo en nombre del usuario.
Consulta la documentación del Portal para socios a fin de obtener información sobre cómo configurar la conexión a tus servidores de reservas de producción y zona de pruebas.
Implementa una interfaz de API de REST
Implementa una interfaz de API basada en REST. Esto permite que Google envíe solicitudes del servidor de reservas a través de HTTP.
Para comenzar, configura un servidor de reservas de zona de pruebas o desarrollo que se pueda conectar al entorno de la zona de pruebas del Centro de acciones. Solo migra a un entorno de producción una vez que el servidor de zona de pruebas esté completamente probado.
Métodos
Para cada tipo de servidor de reservas, se requiere un conjunto diferente de métodos de API. De manera opcional, puedes descargar la definición del servicio en formato proto para comenzar con la implementación de la API. En las siguientes tablas, se muestran los métodos para cada implementación y se incluyen vínculos a los formatos proto del servicio.
| Implementación estándar |
|---|
| Definición del servicio estándar: Descarga el archivo de definición del servicio proto. |
| Método | Solicitud HTTP |
|---|---|
| HealthCheck | GET /v3/HealthCheck/ |
| BatchAvailabilityLookup | POST /v3/BatchAvailabilityLookup/ |
| CreateBooking | POST /v3/CreateBooking/ |
| UpdateBooking | POST /v3/UpdateBooking/ |
| GetBookingStatus | POST /v3/GetBookingStatus/ |
| ListBookings | POST /v3/ListBookings/ |
Recursos de la API
Booking
Los siguientes tipos de recursos se usan en la implementación estándar:
Flujo: Cómo crear una reserva
En esta sección, se explica cómo crear una reserva para la implementación estándar.
Cuando un usuario crea una reserva, Google te envía el nombre, el apellido, el número de teléfono y el correo electrónico del usuario. Desde tu punto de vista, esta reserva debe tratarse como una confirmación de la compra de un invitado, ya que el Centro de acciones no puede buscar la cuenta del usuario en tu sistema. Asegúrate de que la reserva final sea idéntica a las reservas de tus comercios que provienen de tu sistema de reservas.
Seguridad y autenticación
Toda la comunicación con tu servidor de reservas se realiza a través de HTTPS, por lo que es fundamental que tu servidor tenga un certificado TLS válido que coincida con su nombre de DNS. Para ayudarte a configurar el servidor, recomendamos el uso de una herramienta de verificación de SSL/TLS disponible públicamente, como la prueba del servidor SSL de Qualys.
Todas las solicitudes que realice Google a tu servidor de reservas se autenticarán con la autenticación básica HTTP. Las credenciales de autenticación básicas (nombre de usuario y contraseña) de tu servidor de reservas se pueden ingresar en la página Configuración del servidor de reservas del Portal para socios. Las contraseñas se deben rotar cada seis meses.
Ejemplos de esquemas de implementación
Para comenzar, consulta los siguientes ejemplos de esqueletos de un servidor de reservas escrito para los frameworks de Node.js y Java:
- Esquema de Node.js js-maps-booking-rest-server-v3-skeleton
- Esquema de Java java-maps-booking-rest-server-v3-skeleton
Estos servidores simulan nuestros métodos REST.
Requisitos
Errores de HTTP y de lógica empresarial
Cuando tu backend controla las solicitudes HTTP, pueden ocurrir dos tipos de errores.
- Errores relacionados con la infraestructura o datos incorrectos
- Muestra estos errores al cliente con códigos de error HTTP estándar. Consulta la lista completa de códigos de estado HTTP.
- Errores relacionados con la lógica empresarial
- Muestra el código de estado HTTP establecido en
200OK y especifica la falla de lógica empresarial en el cuerpo de la respuesta. Los tipos de errores de lógica empresarial que puedes encontrar son diferentes para los distintos tipos de implementaciones de servidor.
- Muestra el código de estado HTTP establecido en
En la implementación estándar, los posibles errores de lógica empresarial se capturan en una falla de la reserva y se muestran en la respuesta HTTP. Pueden ocurrir errores de lógica empresarial cuando se crea o actualiza un recurso. Por ejemplo, cuando controlas los métodos CreateBooking o UpdatingBooking. Los ejemplos incluyen, entre otros, los siguientes:
SLOT_UNAVAILABLEse usa si el espacio solicitado ya no está disponible.PAYMENT_ERROR_CARD_TYPE_REJECTEDse usa si no se acepta el tipo de tarjeta de crédito proporcionado.
Idempotencia
La comunicación a través de la red no siempre es confiable, y Google puede reintentar las solicitudes HTTP si no se recibe ninguna respuesta. Por este motivo, todos los métodos que mutan el estado deben ser idempotentes:
CreateBookingUpdateBooking
Para todos los mensajes de solicitud, excepto UpdateBooking, se incluyen tokens de idempotencia a fin de identificar de manera única la solicitud. Esto te permite distinguir entre una llamada de REST que se reintentó, con la intención de crear una sola solicitud, y dos solicitudes separadas.
UpdateBooking se identifica de manera única mediante sus IDs de entrada de reserva, respectivamente, por lo que no se incluye ningún token de idempotencia en sus solicitudes.
Los siguientes son algunos ejemplos de cómo manejan la idempotencia los servidores de reservas:
Una respuesta HTTP
CreateBookingcorrecta incluye la reserva creada. En algunos casos, el pago se procesa como parte del flujo de reserva. Si se recibe exactamente la mismaCreateBookingRequestpor segunda vez (con el mismoidempotency_token), se debe mostrar la mismaCreateBookingResponse. No se crea una segunda reserva y se le cobra al usuario exactamente una vez, si corresponde.Ten en cuenta que si un intento de
CreateBookingfalla y se vuelve a enviar la misma solicitud, tu backend debería volver a intentarlo.
El requisito de idempotencia se aplica a todos los métodos que mutan el estado.