iVend POS API
Get to Know and Locate the iVend APIs
This article provides an overview of iVend APIs and helps you locate them at the installed location of the Internet Information Service (IIS) Manager.
Overview
API stands for Application Programming Interface and is a set of functions and procedures that allow the creation of applications which access the features or data of an application or other services for which the API is exposed.
This section provides an overview on iVend APIs
The API framework conforms to the Service Oriented Architecture (SOA) principles and supports Simple Object Access Protocol (SOAP) payloads in the universal XML web services protocol.
For example, it helps in creating database connections, checks database connections, gets country lists, saves countries, gets customers, saves customers, updates single properties of an object and posts transactions.
The iVend API is platform independent and allows developers to integrate it with any other software such as an ERP, accounting software, legacy system, etc.
The iVend API provides a configurable mechanism of securing web service communications by providing options; SSL Based Security and Custom Username/Password based Security.
Locating an iVend API
The iVend APIs work with IIS server, and are installed on the same server machine by default through the iVend installer. All the files related to the iVend API are installed at: [iVend installation path]\CitiXsys\iVend Retail\iVendAPI.
To locate the iVend API:
· Go to the IIS web server.
· Double-click on Site to expand the options.
· Then double-click on Default Web Site to view its sub-lists.
· Now double-click on iVend API as shown in Figure 1.
This will open all the APIs in the right frame of the window called Internet Information Services (IIS) Manager. Refer Figure 2.
· In Figure 3, you can see that the IIS Manager allows you to perform various actions including Manage Server and Deploy.
· To test the iVend API, click the following URL:
Related Articles
Customer unable to do refund invoices in one site due to API Url not working at this showroom
Environment: iVend 6.6 Problem Statement: Customer unable to do refund invoices in one site and getting the error attached at below Error Screenshot: Issue steps : 1. Open POS and press transaction search 2. Search with transaction SA0222000468 3. ...iVend POS Consume API
How to consume an iVend API This article provides an overview about how to consume and use an iVend API. Overview iVend APIs are used to help integrate iVend with third party ERP applications such as; SAP Business One, SAP R3, Microsoft Dynamics ...General Settings in SAP Business One
Introduction The iVend Add-on helps in setting up some configurations required for integrating iVend with SAP Business One. The following sections of this document capture the functionality of the new screens created and new fields added to the SAP ...iVend Patch not getting updated at POS
Environment: iVend 6.6 Patch 7915 Problem Description: Patches in HO and the POS indicates that it has already been updated but in POS it stays in a cycle asking for an update and does not allow it to be done. Scenario: None Solution: 1) At POS the ...Scan Sequence Resolution
iVend POS – Barcode Scan Sequence Resolution Order The user at the POS scans either the barcode of the product when it is being transacted or swipes the loyalty card for the customer or the security user card. The system follows a sequence of methods ...