Sapphire Gateways Overview
The Sapphire Gateways API is used by SapphireOne administrators to streamline the process of importing and exporting specific data sets and is the primary method by which the SapphireOne team migrates new clients data from their legacy systems during implementation. This functionality is particularly useful for organisations looking to amalgamate a data set supplied by a vendor. For instance, a vendor might supply an inventory list in a spreadsheet format that the organisation intends to import, including details such as cost price, details fields, barcodes, and encoded images. The capabilities of the SapphireOne API Gateway are diverse and extensive, catering to a broad range of uses. SapphireOne offers multiple versions of the Gateway, with each iteration described in the subsequent section.
Never directly import gateway files into an active live data file. First, prepare a recent version of your production data file using the same build as the server, and initiate it in Single User Mode. Conduct a trial import with the intended data and meticulously review the outcome, ensuring particularly that the columns in the import file align correctly with the appropriate fields in your data file replica. After confirming the test import is accurate and everything appears in order, proceed to create a backup of the production (live) data file, and only then carry out the actual import. If discrepancies are detected, identify and rectify the issues in the import file, then re-attempt the import with a new copy of the production data file. Always prioritise testing before importing your data.
Sapphire Gateway API Versions
- Sapphire Gateway I – This API is deprecated and remains available for legacy support.
- Sapphire Gateway II – This API facilitates the bidirectional transfer of data into and out of the data file. Users must arrange the columns within the import spreadsheet to align with SapphireOne’s specifications. For reference on the required table formats, please consult the Sapphire Gateway II Tables article.
- Sapphire Gateway III – Offers a more streamlined API for importing selected items into data files with enhanced flexibility. Users can input data into any column in a spreadsheet and then map each column to align with the imported data.
- Primarily, This utility is primarily designed for importing information into newly created data files.
- As such, its capabilities are limited to the options listed in the provided drop-down menu. It’s essential to understand that Gateway III exclusively supports data import processes, and does not include any functionality for exporting data from a data file.
You can review our Blog and YouTube channel for additional information and resources on SapphireOne ERP, CRM and Business Accounting software.