Sistema Emissor de Eventos do Motor de Reservas Plus

Objetivo Configurar e referenciar o Sistema de Eventos do Motor de Reservas para escutar eventos suportados e usar os dados da carga útil em JavaScript personalizado.
Ideal para Administradores de estabelecimento e desenvolvedores web experientes
Use quando Você precisar que JavaScript personalizado escute eventos do Motor de Reservas, trabalhe com cargas úteis de eventos ou responda a alterações suportadas desses eventos.
Requisitos Experiência com HTML, JavaScript e código personalizado no Motor de Reservas
Resultado esperado Seu script personalizado poderá inicializar o Sistema de Eventos e escutar ou disparar eventos suportados do Motor de Reservas usando as cargas úteis documentadas.
Limitações A Cloudbeds não oferece suporte para código personalizado autoaplicado. Personalizações podem exigir manutenção conforme o Motor de Reservas evolui.

Introdução

O Sistema de Eventos permite que o Motor de Reservas se comunique com scripts personalizados e programas externos ao disparar eventos suportados com dados da carga útil. Use-o para receber atualizações do Motor de Reservas e acionar ações personalizadas a partir de JavaScript adicionado nas configurações do Motor de Reservas.

Este artigo explica como inicializar o eventSystem, referenciar eventos suportados e usar os dados da carga útil disponíveis para esses eventos.

 Limitações e notas de manutenção do código personalizado

  • Os passos fornecidos aqui são um recurso informativo adicional para usuários já familiarizados com HTML e JavaScript. Eles são destinados a programadores web experientes.
  • À medida que os produtos Cloudbeds e o Motor de Reservas evoluem, personalizações aplicadas por conta própria podem ficar desatualizadas ou exigir trabalho adicional. A Cloudbeds não oferece suporte à funcionalidade do código personalizado.
  • Teste o comportamento do código após a implementação tanto em Computador quanto em dispositivos móveis, e revise o código personalizado regularmente para mantê-lo atualizado.
  • A Cloudbeds não oferece assistência com design/desenvolvimento de sites de hotéis ou personalizações que não sejam fornecidas pelos nossos Serviços de Personalização profissionais.

Neste artigo

Como usar o Sistema de Emissão de Eventos

  1. Acesse a página de Configurações Settings.png do seu menu Conta Account menu.png e clique na seção Motor de Reservas
  2. Clique em Personalizar
  3. Adicione o código abaixo no campo JavaScript
    Para usar o Sistema de Eventos, você precisa adicionar um listener para o evento on-booking-engine-ready, que expõe o eventSystem da seguinte forma:

    <script>
     window.addEventListener('on-booking-engine-ready', (e) => {
       const { eventSystem } = e.detail;
     });
    </script>
  4. Clique em Salvar

    Booking Engine Customize tab showing the JavaScript field and Save button for adding Event System code

  5. O eventSystem implementa a interface IExternalEventSystem:

    interface IExternalEventSystem {
     addEventListener: (
       event: EventType,
       listener: (payload: PayloadOf<EventType>) => void
     ) => void;
     dispatchEvent: (event: EventType, payload: PayloadOf<EventType>) => void;
     removeEventListener: (
       event: EventType,
       listener: (payload: PayloadOf<EventType>) => void
     ) => void;
    }

    Onde EventType refere-se ao tipo de eventos que podemos disparar ou escutar, e PayloadOf<EventType> refere-se à carga que é enviada com o evento.

Eventos disparados pelo Motor de Reservas

  1.  currency-change evento:

Este evento é acionado quando o usuário altera a moeda do Motor de Reservas a partir do seletor de moeda no cabeçalho. O valor de currency na payload é a abreviação da moeda selecionada, igual à que aparece no parâmetro de consulta currency da URL.

export type CurrencyChangeEvent = {
 event: 'currency-change';
 payload: { currency: Currency };
};
  1. language-change event:

Este evento é acionado quando o usuário altera o idioma do Motor de Reservas a partir do seletor de idioma no cabeçalho. O valor de language na payload é a abreviação do idioma selecionado, igual à que aparece na URL.

type LanguageChangeEvent = {
 event: 'language-change';
 payload: { language: Language };
};
  1. reservation-created event:

Este evento é acionado quando uma reserva é criada no Motor de Reservas.

type ReservationCreatedEvent = {
  event: 'reservation-created';
  payload: CreatedReservation;
};

Quando CreatedReservation for:

interface CreatedReservation {
  booking_id?: `${number}`;
  booking_total?: number;
  checkin_date?: string;
  checkout_date?: string;
  city?: string;
  currency_code?: string;
  custom_payment_method?: string;
  hotel_name?: string;
  nights?: number;
  payment_method?: PAYMENT_METHOD;
  real_booking_total?: number;
  resRooms?: {
    adults: `${number}`;
    id: `${number}`;
    kids: `${number}`;
    package: `${number}`;
    package_name: string | null;
    rate_id: `${number}`;
    room_total: `${number}`;
    room_type_id: `${number}`;
    room_type_name: string;
    room_type_photos: ({
      TYPE?: string;
      alt: string;
      cropParam: string | null;
      croppedImage: string;
      fullPath: string;
      galleryPath?: string | null;
      id: string;
      imageHeight: string;
      imageWidth: string;
      mime?: string;
      originalName: string;
      ownerId?: string;
      ownerType?: string;
      parentId: string;
      path: string;
      section?: string;
      size?: string;
      thumbPath: string;
      uploadedAt?: string;
      utype?: string;
    } & {
      featured: number;
      featuredPath: string | null;
    })[];
  }[];
  rooms?: Record<string, {
    adults: number;
    amount: number;
    bookedId: string[];
    kids: number;
    name: string;
    packageId?: string;
    packageName?: string;
    picture?: string;
    price?: number;
    rateId: string;
    roomId: string;
    unit?: string;
  }>;
  state?: string;
  total_tax?: number;
  widget_property?: number;
}

 Notas sobre custom_payment_method e payment_method

  • payment_method reflete o método de pagamento interno da reserva, por exemplo ebanking ou cards.
  • custom_payment_method é preenchido apenas quando o hóspede seleciona uma Opção de Pagamento Personalizada. Ele contém o id dessa opção; caso contrário, é undefined.

Eventos aos quais o Motor de Reservas se inscreve

  •  custom-payment-option-change 

Este evento é usado por estabelecimentos que desejam oferecer uma Opção de Pagamento Personalizada aos seus clientes.

type CustomPaymentOptionChangeEvent = {
 event: 'custom-payment-option-change';
 payload: {
   id: string;
   instructions?: string;
   name: string;
 };
};

Próximo passo operacional

Agora que você entende como configurar e referenciar o Sistema de Eventos, continue para Adicionar processadores de pagamento de terceiros e cartões-presente ao Motor de Reservas para um exemplo prático usando opções de pagamento personalizadas.

Esse artigo foi útil?
Usuários que acharam isso útil: 0 de 0

Comentários

0 comentário

Por favor, entre para comentar.