Install and Activate API - Knowledge Base | ConnectPOS - Magento 2 POS

Install and Activate API

What is API?

API is of great importance since it helps ConnectPOS “connect” to your Magento. After API is installed and activated successfully, it will start pulling product and customer data to your browser storage and pushing in-store orders back  to Magento.

You can find the link to download the API package on General section in your Admin area.

Install and Activate API

The way API is installed and works is similar to other Magento extensions so you won’t have much difficulty. In case you need help, feel free to contact us.

Prerequisites for installing & activating API

Magento 1

  • Web server: Apache or Nginx installed
  • Database: MySQL 5.6 and above, or MariaDB 10 and above
  • PHP: PHP version 5.6 or above
  • For Magento CE: required version is 1.7, recommended version is 1.8 or above
  • For Magento EE: required version is 1.9.0.0 or above

Magento 2

Support all servers which meet Magento 2 technology stack requirements. See details here

Install API in Magento

Magento 1

There are 2 methods to install API on Magento 1: via Magento Connect or Manual Installation.

Magento Connect installation

Follow these steps to install the extension through Magento Admin:

  1. Unzip the downloaded file you received upon purchasing the extension – locate to the “Magento Connect Installation” folder.
  2. Log in to your Magento Admin
  3. Go to System > Magento Connect > Magento Connect Manager
  4. Login again
  5. On Extensions tab, select Direct package file upload – and browse for the ConnectPOSAPI_1.0.0_20170531.tgz
  6. Click Upload button. Then installing ConnectPOS API module should be successful.

Note: After installation is completed, please flush your Magento Cache, then log out and log in again to your Magento back-end to start configuring the extension.

Manual FTP/SSH installation

  1. Unzip the downloaded file you received upon purchasing the extension – locate to the “Manual Installation” folder
  2. Using FTP/SSH client, connect to your web root folder on your server
  3. Upload folders in Manual Installation above (“app” folder) to your server, ensure keeping the same level with your Magento root folder

Note: After uploading is completed, installation will be done. Please log in to your Magento back-end, flush your Magento Cache, then log out and log in again to start configuring the extension.

Magento 2

If you are new to Magento 2, you probably need a little help to get started before installing an extension:

  • What’s a terminal, command prompt, or Secure Shell (ssh)? (Remember to insert links)
  • Where’s my Magento server and how do I access it?

Before installing API, ensure that you have done the above prerequisites for Magento 2, then try the steps below for installing API:

  1. Unzip the downloaded file you received upon purchasing the extension – you will receive the “app” folder
  2. Using FTP/SSH client, connect to your web root folder on your server
  3. Upload this “app” folder to your Magento server, at the same level with your Magento root folder
  4. Confirm to merge folders (optional, some FTP/SSH client would ask for merging folder)
  5. After merging is completed, open your terminal application and run below command lines: – cd magento_2_root_folder (change to Magento root folder) and – php bin/magento setup:upgrade
  6. Wait a second to complete installation process
  7. Go back to Magento 2 back-end > Stores > Configurations to check if the extension is installed properly. It should show up in your menu bar like below

Activate API in Magento

Try the following steps to configure API in Magento:

  1. For Magento 1, go to back-end > Systems > Configurations > SmartOSC > ConnectPOS
  2. For Magento 2, go to back-end > STORES > Configuration > SmartOSC > ConnectPOS
  3. Then input the following information:
    • License key: enter the license key you get from email after registering for free trial or purchasing our license
    • Enable: Yes
  4. Click “Save Config” button to activate the license

How can I know that API is installed and activated successfully?

In your Magento back-end, if you see SmartOSC > ConnectPOS show up, it means that you’ve installed it successfully.

After you click “Save Config” button to activate API, if the message “The configuration has been saved” appears, you can go to your Sell Screen and start selling now.

Request a Personalized Demo
Let's introduce yourself a bit so we can consult the best-fit solution & save your time

 
close-link