README

Api53 provides Headless solutions for eCommerce.

www.api53.com

Works with:

Key Features • Getting Started / Installation • Documentation • Support • License

Key Features

• This extension exports your entire product catalog to Api53 and you can use it to create CSV files
• Yes, we make your eCommerce shop headless through the API we offer
• Decoupling the product catalog from your magento shop
• Creation of a dedicated API endpoint over Api53.com
• Near real-time synchronization of the entire catalog
• Multi tenant user control for Headless API
• ...and many more

Getting Started / Installation

To be able to install this Magento module, you need SSH access to your server.

Installation via Composer

You can install our module via composer. You can find the Api53 composer package at the following address: https://packagist.org/packages/api53/api53-magento-2

After successfully login to your Magento server, please go to the root magento directory and run the following commands:

# Install Api53 Module by using composer
$ composer require api53/api53-magento-2

# Enable Api53 module
$ php bin/magento module:enable Api53_Api53

# Run setup:upgrade
$ php bin/magento setup:upgrade

# Complete the setup
$ php bin/magento setup:di:compile

# Deploy static content
$ php bin/magento setup:static-content:deploy

# Clean cache
$ php bin/magento cache:clean

After successful installation you can check whether the module has been activated:

$ php bin/magento module:status

Manual installation

After successfully login to your Magento server, please go to the root magento directory and run the following commands:

# Download the latest Api53 Magento extension release from GitHub
$ wget -O api53.tar.gz https://github.com/Api53/api53-magento-2/tarball/main

# Create Api53 directory inside app/code
$ mkdir -p app/code/Api53/Api53

# Unpack the Api53 extension 
$ tar -xf api53.tar.gz -C app/code/Api53/Api53/ --strip-components=1

# Enable Api53 module
$ php bin/magento module:enable Api53_Api53

# Run setup:upgrade
$ php bin/magento setup:upgrade

# Complete the setup
$ php bin/magento setup:di:compile

# Deploy static content
$ php bin/magento setup:static-content:deploy

# Clean cache
$ php bin/magento cache:clean

Enable Api53 Magento extension

Api53 module was successfully installed. You can enable it in Stores -> Settings -> Configuration -> Api53

Please Note:
This Magento module use cron to init your catalog with Api53. Make sure your Magento cron is running propertly.

To use the module you need a valid Api53 Shop API key. To get a key you have to create a new Api53 account (Free sign up - No credit card required). You can read more details in our documentation here.

The initial catalog sync process may take some time. Up to 15 minutes. It all depends on how many products are synced with Api53.

Export product catalog to Api53

To export your product catalog to Api53, you have two options:

1. From Admin Frontend

Login to Magento Admin Frontend and open Api53 extension page under Configuration -> Api53. Enter the Api53 API Key that you previously generated on www.api53.com for your eCommerce shop. After you have saved all the information, a cron command will run in the background. Your products should appear in Api53 within a few minutes.

2. From Shell Command Line

You can also export your entire catalog of shell command line. To do this, however, you must first have entered the Api53 API Key in the Admin Frontend.

Catalog export via shell command has the advantage that it does not use cron running in the background. That means all products are exported immediately.

$ cd /my/magento2/dir 
$ php bin/magento api53:export-products

Documentation

We also have an internal wiki how you can use our Api solution:

• Setup Guide
• Install Magento 2 module
• How to use Api53 CSV API

Support

This magento module is fully supported. That means if you have any questions or suggestions please contact us via email support@api53.com or Twitter @api53com.

License

Apache-2.0 license

api53.com  ·  Twitter @api53com