Server Hunter Sync

Keep your Server Hunter listings matching your Blesta packages automatically, so you never sell a deal you changed or retired weeks ago.

What it does

Once a package changes, price changes, or sells out in Blesta, your Server Hunter listing does not know about it until you go and edit it by hand - and it is easy to forget. Server Hunter Sync links a Blesta package to a Server Hunter offer once, then keeps them in step for you: every few minutes it pushes the package's name, visibility, stock, price, setup fee, and billing interval up to the matching listing, so what a buyer sees on Server Hunter is always the deal you are actually selling.

Key features

• Packages Pushed Straight to Your Listings: Link a Blesta package to a Server Hunter offer once and its details are pushed up for you every few minutes, so the listing a buyer sees is always the deal you are actually selling.
• Pick the Offer From a List: Choose the Server Hunter offer from a dropdown populated live from your own account instead of copying identifiers by hand, with a plain text box as a fallback if the connection is unavailable.
• Choose Exactly What Each Job Syncs: Every link has independent switches for name, visibility, stock, price, setup fee, and billing interval, so you can keep your listing's own wording while still pushing live stock and pricing.
• Stock and Availability Kept Honest: Package stock and active or inactive status are carried straight through to the listing, so an offer that has sold out or been retired stops advertising itself.
• Monthly Price Normalization: Prices on annual, six-month, quarterly, weekly, or daily terms are converted to the monthly figure Server Hunter expects, so your listing price stays comparable no matter how you bill.
• Currency Control Per Job: Nominate which of your currencies each job takes its pricing from, so a multi-currency catalogue lists the right number without surprise conversions.
• Sync Now on Demand: Push a single link immediately, or every link at once, from the job list without waiting for the next scheduled run, and get the result reported back on the spot.
• One-Click Connection Test: A test button on the settings page checks your credentials against the live service and reports back exactly what it said, without saving half-typed settings or waiting for a real event to fire.

Installing Server Hunter Sync

Before you start

• If you are on the leased (subscription) licence, the Blesta Club Subscription Manager must be installed and your subscription active. The owned and owned-source licences have no such requirement.

1. Upload the files

Upload the extension folder into your Blesta installation so it lands under your Blesta directory at:

plugins/server_hunter_sync/

For example, on a typical install: /var/www/html/blesta/plugins/server_hunter_sync/

2. Install it in Blesta

1. Log in to your Blesta admin area with a staff account that has the Plugins permission (specifically Install Plugin and Manage Plugin) under the Settings group in Manage Staff Groups.
2. Go to Settings > Company > Plugins and click the Available tab.
3. Find Server Hunter Sync in the list and click Install.

3. Configure it

1. On the Installed tab, click Manage next to Server Hunter Sync to open its settings screen.
2. Enter your Server Hunter API key. You can generate one from your Server Hunter account under Information for Providers > Manage Account > Manage (on your company) > API > Generate API Key. If you want to try the plugin out first, tick Mock API instead - this runs every screen and sync off bundled sample offers so you can see exactly how it behaves before you have a real key.
3. Click Save changes. You can click Test API key first to check a key you just typed without saving it - if you do, retype the key before saving, since the field is cleared again after a test for security.
4. Once saved, the plugin's cron task runs automatically every 5 minutes - no further setup is needed to keep it syncing.
5. Go to Settings > System > Staff > Staff Groups and, for every staff group that should manage offer sync jobs, tick the Server Hunter Sync permissions (List / Add / Edit / Delete Offer Sync Jobs and Sync Offer Sync Jobs Now). A fresh install grants these only to the staff member who installed the plugin - every other group needs them ticked before its members can see the Server Hunter link under Tools.

You're ready to go - see the usage guide for a walkthrough of day-to-day use.

Updating Server Hunter Sync

Upgrading works just like installing: upload the new files over the old ones, then run the upgrade from the same page you installed it on.

1. Back up your current extension files first - good practice before any upgrade.
2. Upload the new version over the existing folder, replacing the old files at plugins/server_hunter_sync/.
3. Log in to your Blesta admin area and go to Settings > Company > Plugins.
4. Find Server Hunter Sync on the Installed tab and click Update to run the upgrade.

Version-specific notes

• Version 2.0.0: Adds staff permissions for the Server Hunter page for the first time, and if you are updating from version 1.0.0 (the case for every existing customer) Blesta registers all five unchecked, so the entire "Server Hunter" link under Tools disappears for every staff group, including administrators, until you grant it:

  1. Go to Settings > System > Staff > Staff Groups and edit each group that should have access.
  2. Under the Server Hunter Sync section, tick List / Add / Edit / Delete Offer Sync Jobs and Sync Offer Sync Jobs Now (the last one is what the "Sync now" and "Sync all now" buttons need).
  3. Save the group.

  This version also splits the single Sync Price toggle into separate Sync Price, Sync Setup Fee, and Sync Billing Interval toggles. Existing sync jobs are migrated automatically so the two new toggles follow whatever Sync Price was set to, so no job changes behaviour on update.

  Your API key is also encrypted on update. The key field on the settings screen is now masked and starts empty every time: leave it blank to keep the stored key, and only type in it when you want to replace it. The "Test API key" button tests the stored key when the field is left blank.

  If the update reports a database error, run it again once the cause is fixed - the migration checks for each column before adding it, so re-running it is safe.

Using Server Hunter Sync

For your staff

Settings screen

Under Settings > Company > Plugins, find Server Hunter Sync on the Installed tab and click Manage. This is where you store your Server Hunter API key and turn Mock API on or off. Click Test API key to check whatever is currently typed (or, if the field is left blank, whatever key is already saved) against Server Hunter and get an immediate "Connected successfully" message with the number of offers found, or an error if the key is wrong - nothing is saved by this button. Click Save changes to store the key and the Mock API setting.

Offer Sync Jobs list

Click Server Hunter under the Tools menu to see every offer sync job, one row per linked package. Each row shows the Server Hunter Offer ID, the Blesta package it is linked to, and a Yes/No column for each of the six things that job can sync (shown in green for Yes, red for No), plus the currency it prices from. Use the funnel icon to filter the list by package, currency, or any of the sync switches. From here you can Edit or Delete a job, or click Sync now on a single row to push that job immediately instead of waiting for the next scheduled run.

Adding or editing an Offer Sync Job

Click the + button to add a new job, or Edit on an existing row. Each job has:

• Offer ID: the Server Hunter offer this job pushes to, chosen from a dropdown populated live from your account. If Server Hunter cannot be reached when the form loads, this becomes a plain text box instead so you can still enter the identifier by hand.
• Package To Sync: the Blesta package whose details are pushed to that offer.
• Sync Name, Sync Visibility, Sync Stock: independent switches for whether the package name, visible/hidden status, and active/inactive status are pushed to the offer.
• Sync Price, Sync Setup Fee, Sync Billing Interval: independent switches for the three pricing fields. Turning any of these on makes the Sync Currency field required, since pricing is looked up in that currency.
• Sync Currency: which of your company's currencies this job's pricing comes from. Prices are not converted between currencies - pick the currency the package is actually priced in.

Click Submit to save. New offers you have just created in Server Hunter can take up to 5 minutes to appear in the Offer ID dropdown, since the list is cached briefly to avoid a live lookup on every page load.

Syncing

Every 5 minutes, Blesta's cron automatically pushes every job's changes to Server Hunter. You do not need to do anything for this to happen once the plugin is installed and configured. To push immediately instead of waiting, click Sync now on a single row, or Sync all now above the table to run every job in the company at once. Either way you land back on the list with a message confirming the sync ran.

Good to know

• Prices are normalized to a monthly figure before being sent, since that is what Server Hunter expects: annual, six-month, and quarterly prices are divided down, and weekly or daily prices are multiplied up. Your package's own pricing display in Blesta is not affected.
• Pricing is matched using this preference order among your package's configured terms: 1 year, then 6 months, 3 months, 1 month, 1 week, and finally 1 day. If none of your currencies and terms line up with a job's Sync Currency, that job's existing price on Server Hunter is left alone rather than being overwritten with a wrong figure.
• A package with no separate renewal price uses its signup price instead. If the calculated price ever comes out to zero or less for a package that is genuinely priced, the sync leaves the listing's existing price untouched rather than publishing a zero - a genuinely free package still publishes as free.
• Hidden packages can be linked just like visible ones - the Package To Sync dropdown includes them.
• If a sync fails (for example, the offer no longer exists on Server Hunter, or the API key is wrong), the failure is written to Blesta's log rather than failing silently, so a failed cron run is easy to spot.
• The API Key field is always shown blank for security, even right after you save a key or test one. If you use Test API key before saving, retype the key before clicking Save changes - otherwise leaving the field blank on save keeps whatever key was last saved (or saves it as empty on a brand new setup that has never been saved before).