ACCESSING THE WEB API

Webopedia definition of "API"

API - application program interface

API, an abbreviation of application program interface, is a set of routines, protocols, and tools for building software applications. The API specifies how software components should interact and APIs are used when programming graphical user interface (GUI) components.  A good API makes it easier to develop a program by providing all the building blocks. A programmer then puts the blocks together.

Types of APIs

Please click this link to know more: http://www.webopedia.com/TERM/A/API.html

Please click to read first the blog on "3RD PARTY INTERFACE IS POSSIBLE IN IKONOMIKAL".

Accessing the Ikonomikal Web API

Content:

1. Requirements
2. Enable WEB API
3. Granting Access To Roles
4. Request And Response Method 
• JSON Format Example
• Class Example
• JSON Serialized/De-serialized to Class
5. Basic Example (“Adding A New Department”)
• Log-In
• Requesting for a "NEW" token
• Executing the "NEW" procedure
• Complete the Program
6. 3rd Party Interface
• Why Mapped Fields and Batch Upload is Recommended?
• Why API in Real-Tim Communication is not Recommended?

1. Requirements

The following are the major requirements to access the API:

Functional:

1. Registered Email ID
2. Active company subscription
3. Currently assigned to a company by invitation
4. Enabled API Access (to bypass the captcha requirement)

Development Language:

1. Must support Classes
2. Must support JSON Format
3. Must be able to Serialize and De-serialize JSON
4. Must support HTTP or Web Request

2. Enable WEB API

Enabling WEB API from Ikonomikal User Home Page

3. Granting Access To Roles

Example: Granting “NEW” access to Department Profile

4. Request And Response

Ikonomikal API’s are accessed by issuing a POST request And receiving a response in JSON Format.

Note: This cannot be done on the browser unless the Cross Origin Resource Sharing (CORS) policy is disabled.

4.1 JSON Format Example

4.2 Class Example

4.3 JSON Serialized/De-Serialized To A Class

5. Basic Example

“Adding A New Department Profile”

5.1 Log-IN

5.2 Requesting for a “NEW” token

5.3 Execute the “NEW“ procedure

5.4 Complete Program

6. 3rd Party Interface

• Why Mapped Fields and Batch Upload is Recommended
• Why API in Real-Time Communication is not Recommended.

6.1 Mapped Fields And Batch Upload

THIS IS AN IKONOMIKAL PROGRAM

Fully Integrated With Other Ikonomikal Programs

THIS COULD BE YOUR PROGRAM

FEATURES:

• Your programs’ performance will be based on how much hardware you install.
• You can add any field or data you want in future revisions without asking us to modify our system.
• Your program will only communicate with Ikonomikal during a scheduled batch upload and use the ikonomikal MAP field in place of the Department Code. 
• The batch upload data is scheduled and can be monitored and then corrected before it goes to ikonomikal.
• Operations users can continue working even if ikonomikal is under maintenance or if you suddenly lost connection to ikonomikal. Only the batch upload will not run.
• Use this technique if you want to minimize inter system maintenance down-times. 

Think of a Point Of Sale System that connects to an ERP or any Accounting System. 

With mapped fields and batch upload, customers and cashiers are able to complete transactions even when the ERP or Accounting System is on maintenance.

Mapped Fields and Batch Upload is recommended

6.2 API in Real-Time communication

THIS IS AN IKONOMIKAL PROGRAM

Fully Integrated With Other Ikonomikal Programs

THIS COULD BE YOUR PROGRAM

FEATURES:

• You will have to map your program users to ikonomikal users so they could be assigned with the correct Roles (this is for each User you create in your system). 
• You need constant API Access and needs uninterrupted availability of ikonomikal.
• Which ever system is slowest, is your overall systems’ performance.
• The reverse of the features mentioned in the “MAPPED FIELDS AND BATCH UPLOAD”.

API in Real-Time communication is not recommended

THIS IS ONE OF THE REASONS WHY 

YOU HAVE TO COMPLETE YOUR SYSTEM SO IT CAN RUN INDEPENDENTLY

Ikonomikal Sample API of a Department Profile.

Please do the following:

1. Click this link : https://github.com/iamshotgun/IkonomikalAPISamples

2. Click Clone or download

3. Download Zip

Requirements:

Visual Studio 2013

VB.NET

Microsoft .NET 4.6

You may also be interested to know (please click to browse):

1. What are the Security Features of Ikonomikal?
2. How Robust is Ikonomikal?
3. What is Ikonomikal SSL Security Level? 
4. Is 3rd Party Interface Possible in Ikonomikal?
5. Ikonomikal Programming Language and Environment Diagram
6. Company website of Ikonomikal
7. Ikonomikal software site
8. What is Ikonomikal?

Click to Email: Teodoro Rolluqui

Accessing the

Ikonomikal Web API