NautiX Push

To increase the speed of updates on other portals, we are introducing NautiX Push. With this simple concept, changes to the boat inventory can be transferred to other partners within a few minutes.

Participants

  • Broker X: is a mutual customer at Portal A and Portal B

  • Portal A: this is where the broker X is managing his boat inventory. Portal A is providing a NautiX data feed for Portal B

  • Portal B: is importing the boats of broker X from Portal A, without NautiX Push it is simply fetching the data feed once a day

Basic Concept

  1. Broker X lowers the price of one of his boats

  2. Upon saving the changes, Portal A is calling a webhook at Portal B to notify the partner portal about a change in the inventory

  3. The change is now queued on Portal B, which will download the NautiX data feed from Portal A at the next opportunity and apply the latest changes

Portal B will always update the full inventory of the customer after an update is registered with the webhook. It is not intended to load and update data for a single boat. This is to keep the process and data structure as simple as possible.

Technical Example

For any changes to an ad, Portal A calls the webhook at partner portal B:

https://www.portal-b.com/api/nautix/push?portal=[PORTAL-A-KEY]&account=[CUSTOMER-X-TOKEN]

  • Portal-Key: this is an API key for Portal A provided by Portal B. This is not necessary but recommended

  • Customer/Account-Token: this is the Account-ID of the customer that Portal A is sending in the NautiX data feed. It serves both portals to identify the customer.

The webhook is sending a response:

{"status": "success", "account":" Customer X", "message": "update_registered" }

For simplicity, the webhook response is in JSON format. A clear structure is not mandatory and the content does not need to be checked. It is only recommended to check whether the webhook was successfully called.

Recommendations

The webhook should not directly trigger an update via the data feed. We recommend bundling updates and checking every 15 minutes to see if any changes are pending.

The webhook only notifies the receiving Portal B that an update for Customer X is pending. It is still recommended to check the feed about once a day, even without webhook notifications. This ensures that the inventory on Portal B remains up to date in case of errors with the webhook communication.

The NautiX Push via webhook will be an optional feature for portals that want to speed up data exchange between themselves. Without using the webhook, everything will continue to work as usual and data will be synchronised conventionally via cron job or manually at regular intervals.