Supplier integration checklist

This page includes all steps/tasks needed for supplier integration. Feel free to contribute.

tasks before starting integration implementation

• get servers (production / staging) information
• get API documentation
• get API access information (tokens, username-passwords and so on)
• ensure we have working access to the API
• determine type of client API (JSON, XML, SOAP)
• determine cancellation policy for the supplier

common integration parts

• update credentials.yml
• update apps/api/config/initializers/validate_supplier_credentials.rb
• update apps/api/config/environment_variables.yml
• update .env* files
• update middlewares/authentication.rb
• validate credentials https://github.com/roomorama/concierge/pull/117
• integration wiki page update https://github.com/roomorama/concierge/wiki
• decide which supplier endpoint actions can be cached

quote price

• add controller routing
• add controller action
• add controller specs
• include quote shared specs examples
• add client implementation returning result wrapping proper Quotation
• add client specs + fixtures
• add documentation for all classes / methods
• make sure webhook is working properly

booking

• add controller routing
• add controller action
• add controller specs
• include booking shared specs examples
• add client implementation returning result wrapping proper Reservation
• add client specs + fixtures
• save reservation to database + add specs
• add documentation for all classes / methods
• make sure webhook is working properly

cancellation

• add controller routing
• add controller action
• add controller specs
• add documentation for all classes / methods
• add client specs + fixtures
• add documentation for all classes / methods
• make sure cancellation is working properly with staging server
• is there any restrictions on before which day reservation can be cancelled?

sync worker

• worker implementation according wiki: https://github.com/roomorama/concierge/wiki/Setting-up-the-development-environment
• enable / disable context tracking: https://github.com/roomorama/concierge/pull/103
• announce_error implementation
• test worker locally by running and check for errors in concierge web

sync importer

• build properties
• build units
• build availabilities
• build images
• implement amenities mapping
• cache implementation if needed