Open Data API
Updated over a week ago

Definition of API

Application Programming Interface (API) is an interface that a software program implements to allow other software’s to interact with it. Similarly, software might also implement a user interface for users.

APIs are implemented by applications, libraries and operating systems to define how other software can make calls to or request services from them. An API determines the vocabulary and calling conventions a programmer should employ to use such services. It may include specifications for routines, data structures, object classes, and protocols used to communicate between the consumer and implementer of the API.

About the Asite API

Asite API is an interface that allows other software applications to interact with the services and data stored within the Asite Business Operating System (ABOS) platform. Asite API supports both REST based and SOAP based interfaces.

REST Based API: REST (representational state transfer) is an approach for getting information content from a Web site by reading a designated Web page that contains an XML (Extensible Markup Language) file that describes and includes the desired content.

SOAP based API: SOAP is a protocol for accessing a Web Service. SOAP is a simple XML-based protocol to let applications exchange information over HTTP.

SOAP, defined as Simple Object Access Protocol, a protocol specification for exchanging structured information in the implementation of Web Services in computer networks. It relies on Extensible Markup Language (XML) for its message format, and usually relies on other application Layer protocols, most notably Remote Procedure Call (RPC) and Hypertext Transfer Protocol (HTTP), for message negotiation and transmission.

This essentially means that you can send an HTTP GET or POST to call exposed methods, and you'll get back an XML document in return.

The Asite API defines the vocabulary and calling conventions the programmer should employ to use the services. The Asite API consists of a set of callable methods, and API endpoints and expects all data to be UTF-8 encoded. The Asite API thus enables the combination of multiple services into new applications or mashups.

The REST Based API uses the RESTEasy framework. RESTEasy is a JBoss project that provides a framework to build RESTful Web Services and RESTful Java applications. It is a fully certified and portable implementation of the JAX-RS (Java API for RESTful Web Services) specification.

The Asite Portlet container is based on portlet specification which is an open standard. The Asite Platform is open for our users and partners to develop their own mashups and incorporate them into their personalised views or even share them with colleagues, the supply-chain and beyond. The Asite Portlet enables you to bring the content from your SharePoint web-part into the Asite portal homepage in real-time. You can pull supply chain data from the Asite platform straight into your SharePoint web-parts. Asite Portlet container runs on top of LifeRay Portal which is JSR-168 and JSR- 286 (both are portlet specification complaint).

Asite AppBuilder is a development framework allowing you to build Forms that run within the Asite platform. The framework is based around the Microsoft InfoPath’s .XSN format. It allows you to use a WYSIWYG design interface to create the form’s Interfaces as well as data points (effectively data-base fields are called Data Source) for the form. Advanced functionality can also be developed using jscript code. Forms can also be developed with multiple forms that work together to create a larger application. These Apps use Data-Connections between the forms (using the SOAP Based API) to allow the forms within the App to call data between themselves.

Asite API Services are designed to support the requirements of multiple entities, namely:

  • Individual users,

  • Customer Organisations,

  • Third Party systems, and

  • Public data access

API framework:

  • is independent of Client Languages used in their applications;

  • is independent of Client Web Browser and is scalable for Component interactions;

  • supports independent deployment of components and field selectors;

  • immediately integrates with any applications that uses Asite API;

  • manage and respect data validations, workflow and security of information;

  • requires authentication for user credentials. This is a must for any request being received in Asite Platform or sent from Asite Platform.

  • can receive HTTP requests and sending back XML data to Client Applications accessing data from internal and external applications;

  • is flexible for users to specify a list of fields that can be sent with the request.

Click here for detailed help on Asite API Services.

Did this answer your question?