Getting Started

The API allows third party developers to connect and (depending on authorisation) Create, Read, Update, Delete core and transactional data in MYPOS Connect.

Follow the steps below to get started with the MYPOS Connect API. 

‍

Request a login and test environment setup

To build and develop systems that integrate with MYPOS Connect you will need a login, a test database and authorization from the MYPOS Connect end client.

Step 1 : First go to https://portal.myposconnect.com/register and register with your email address. This is the one you will use for development. A live login will be provided later.

Step 2 : Ask the MYPOS client you are working for to also contact the MYPOS helpdesk from a verified email address introducing you the developer and describing the project. A database will then be setup for you with suitable data for test development. Please note that without authorisation from the end client we cannot setup a test database access or provide a login and we cannot start this process early.

‍

What you will need

Step 3 : Our favourite software development environment is Postman, and we provide example downloads and screenshots for this. Please install Postman by clicking here, or alternatively, use your favourite software development environment.

‍

Next Steps

Step 4 : Read API Build Basics. This covers the API; Bearer Tokens and how long they are valid for and API options.

Step 5 : Read API Best Practices to help with your design.

Step 6 : Read API Fair Usage By using Best Practices your application will not be prevented from accessing data.

Step 7 : Read API Data Structures to learn more about data formats.

Step 8 : Read API vs CSV File Drop to learn of alternates.

Step 9 : Read Stores API to read a store. Think of this as the "Hello World" app, if this does not work then the login has not yet been set up correctly.

Step 10 : Download the Postman samples here and If there are any further questions please email us at [email protected]