Overview
The Connect API is a simple online interface that allows practice management systems to exchange information electronically with Provet. We currently support order placement, querying of product information and downloading of invoices. To ensure that we can provide a high quality consistent service to all our users we require all VPMS using our API to fully implement the following features
Mandatory Features
-
Place an Order via our 2-step process
- Submit an order via API
- Launch the Provet Connect Website via the URL returned from the API
-
Download an invoice
- Update the stock on hand in the VPMS
- Flag the appropriate lines on the order received
-
Secure authentication system
- Store the unique VPMS key in your source code/database or encrypted in a file (this is a single key to uniquely identify the VPMS placing the order) and keep this confidential
- Implement the User Enrolment Process per the API documentation, which involves storing a unique token for the clinic
-
Product List Export/Import
- Provide a mechanism to export the clinics product list in CSV format for the purpose of allowing Provet to identify the correct Product Code for each item
- Provide a mechanism to load the completed code match using the same file format
Recommended Features
- Update the sell prices in the VPMS according the pricing rules/processes of the system or appropriate reporting to allow the user to perform this function
- Create a product by looking it up in the Provet Catalogue (rather than manually enter it)
All information communicated via the API must be used solely for the benefit of the enrolled clinic and may not be aggregated, shared or published for the use by anyone else.
Ordering
Provet Connect provides a simple 2 step ordering process. The order may be created in either the Connect Website, Practice Management System or on one of our Portable Data Terminals. The order may then be modified on the Connect Website (or the IOS Scanner) before the user confirms the order and submits to Provet for picking.
Order Confirmation Page
There is a 2 step process to submit an order to Provet:
- The order is placed via the API
- The user confirms the order from the Connect Website via a one-time link opened by the VPMS
This ensures that our system complies with health department regulations and ensures that our customers are provided all available information related to the order including promotions, quantity breaks, stock availability and accurate pricing options.
Below is a sample confirmation page, the user can simple click Send Order if everything is correct.
Invoice / ASN
Provet provides a combined Invoice / Advance Shipping Notification Feature that allows a Vet Practice to manage their pricing, ordering and stock levels.
Once an order departs the Provet Warehouse an invoice is made available for downloading into the VPMS. The VPMS should check for Invoices either on Customer Request or regular intervals (no more often than 5 minute intervals).
Security
It is important for both parties to keep communications secure. Security is provided using an OAuth style system where the VPMS does not need to store the users username and password. Security is provided by:
- Identification of the VPMS using a unique token
- Authenticate the user via a unique token
- All communication provided over HTTPS
- All tokens to be stored encrypted by the VPMS
Enrolment
There is a one-time enrolment mechanism for each user accessing the Provet Connect Interface.
- The VPMS initiates enrolment and receives a request Id
- The user is required to log into Provet Connect
- Once the user is logged in they are provided the Key
- The key is also retrievable via the GetEnrolment API, which the VPMS can call passing the RequestId
- This same functionality is provided from the Provet Connect Site
Product Import / Export
For this integration to work, both systems need a common identifier to represent each product. This identifier is stored in the VPMS in the form of a supplier product code. The VPMS must provide an import and export function of the clinics full stock list with this product code to allow the Provet Team to assist the clinic with this match up. This file should contain:
- VPMS Product Identifier
- Description
- Provet Code if known
- Manufacturer Product Code
- Product Barcode
- Cost Price
- Pack Size Information
Product Information
Search
The API provides a Product Search Function to allow a clinic to add a new product to their practice management system or to identify the correct Provet Product for one of their existing products in their VPMS database.
Product Query
A product may be queried as part of the ordering process to get the latest pricing and availability details.