Application Programming Interfaces (APIs) - a Layman’s Guide to start.

 An API, or Application Programming Interface, is like a bridge that allows different software systems to communicate and interact with each other. Imagine you're at a restaurant ordering food. You don't need to go into the kitchen and cook the meal yourself; instead, you communicate your order to the waiter, who then conveys it to the kitchen staff. In this analogy, the waiter is like an API, serving as an intermediary between you (the user) and the kitchen (the system providing the service).

‍

APIs define the rules and protocols for how different software components should interact, making it easier for developers to build new applications or integrate existing ones without needing to understand all the underlying complexities.

 In simpler terms, an API is like a set of rules and tools that developers use to build software applications. Just as a Lego set provides standardized pieces that you can use to construct various models and creations, an API provides pre-defined functions and data structures that developers can leverage to build software more efficiently. For instance, if you're building a weather app, you can use a weather API to fetch current weather data instead of writing all the code to gather that information yourself. APIs abstract away the nitty-gritty details of how certain features or services work, allowing developers to focus on building their applications without reinventing the wheel.

 An API fetches data from a SQL database by acting as a middleman between the database and the application requesting the data. Imagine you're asking for information from a library database. Instead of going into the library's storage room yourself, the librarian (the API) retrieves the books you need and brings them to you. So, importantly here, you are not allowed into the storage room yourself. Similarly, the API sends a request to the SQL database, specifying what data it needs, such as book titles or authors. The database then processes this request and sends the relevant data back to the API, which finally delivers it to the application in a format the application can understand, like JSON or XML.

 Once the API receives the data from the SQL database, it organizes it into a format that the requesting application can easily work with. This might involve converting the data into a structured format like JSON (JavaScript Object Notation)or XML (eXtensible Markup Language). JSON, for instance, resembles a collection of key-value pairs, making it easy for applications written in various programming languages to parse and manipulate the data. The API then sends this formatted data back to the application, which can then use it to display information to the user, process it further, or perform any other required actions.

Implementation examples

So, the MYPOS Connect API allows you to customise your EPOS system in that it is easy to integrate with other software that also has APIs. The majority of modern cloud-based brands such as Xero, QuickBooks, Mailchimp and Bartender all allow you to send and receive data. Some examples of what can be achieved :

Integrating with ERP systems such as Salesforce, SAP, WinMan and Caliq allow data exchange and tighter integration. This might mean sales are sent from MYPOS to the ERP system and the products and stock sent from the ERP system to MYPOS EPOS software. Stock usage is sent back to the ERP system either on a real time or batch basis.

Integrating with accounts systems such as Xero and QuickBooks, also allows data exchange and tighter integration. This might mean for example a journal is created in the accounts package at the end of the day / week / month with the sales information and stock usage.

Integrating with marketing products such as Mailchimp allows the customers details to be shared for marketing information. As they sign up on the till they are added to the mailing list. For marketing the API also allows loyalty apps to be created, either in house or externally, that shows the sales and promotions available.

Integrating with utilities, for example labelling with bartender or stock count facilities is also available visa the API. We also offer our own free inventory count app to those that need.

Further Resources

When you are ready to implement an integration, we can help with Postman collections providing examples. We are keen to make sure all integrations work as smoothly as possible so our support team can help advise on the best ways to integrate with the MYPOS Connect Electronic Point of Sale (EPOS) Software.