The Yello API is the overall name given for all of the Yello's APIs (available publicly
online via
www.yelloco.com) provided via
the yOS.
The yOS represents the firmware running on Yello terminals at the secure payment processor
level, application processor level and SFPGA level. It constitutes as well all the services provided
by the firmware.
The Yello library is a multi-platform Java library implementing the Yello APIs. It provides access
to all the services provided by the yOS running on Yello terminals. The library can be used
by customers either from their Android business application running on the Yello terminal or
from their business application running remotely on a PC or server.
The APIs provided by the Yello library are divided into the following categories.
- The Yello EMV Payment APIs to perform Contact/Contactless/Magstripe EMV transaction on the
Yello terminal. For more information see the
Transaction
singleton class.
- The Yello Alternative Payment APIs to perform transactions via alternative
payment providers like Yoyopay, WeChat Pay, Samsung Pay, etc. The APIs for performing those
types of transactions will be provided in a later version of the Yello API.
- The Yello System APIs, which allow the customer application to access hardware-related
features provided by the Yello terminal, for example LED ring, card detection, etc. These
include also non security-critical functions provided by the secure payment processor
available on the Yello terminal. For more information see classes
Sys and EventManager.
- The Yello Secure APIs, which allow customer applications running either on the Yello
terminal or on a distant server or PC to perform security-critial operations with the
secure payment processor on the Yello terminal (for example EMV configuration database
update inside the secure payment processor). The use of these APIs requires credential
access from Yello in the form of an SSL certificate and SSL private key.
For more information see
com.yello.api.secure
the package.
Yello Library dependencies
As from release 1.0.1, the Yello Library is dependent on the google's guava package.
The Yello Library was tested and validated with version
27.1-android of guava.
This version can also be used when running the Yello Library from a PC or server.
Guava dependency can be added to an Android application by updating the
dependencies
section of the application's
build.gradle file as follows:
dependencies {
...
implementation group: 'com.google.guava', name: 'guava', version: '27.1-android'
}