Example external e-commerce shop integration

Prerequisites

1. AMPER API KEY

2. AMPER web serivce URL

To get those, please, contact with IT support of company you want to integrate with.

Example request

C#

var client = new RestClient("<https://{amper_ws_url}/external/v1/products/?api_key={amper_api_key}>");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

NodeJS

var request = require('request');
var options = {
  'method': 'GET',
  'url': '<http://{amper_ws_url}/external/v1/products/?api_key={amper_api_key}>',
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

PHP CURL

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '<http://{amper_ws_url}/external/v1/products/?api_key={amper_api_key}>',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Python

import requests

url = "<http://{amper_ws_url}/external/v1/products/?api_key={amper_api_key}>"

payload={}
headers = {}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

replace "amper_ws_url" and "amper_api_key" with your data

Response

As a response you will get JSON. Example response with list of products

[
    {
        "id": 1037,
        "name": "BAHAMA zapach samochodowy NASZYJNIK Wild Hibiskus /1szt",
        "short_code": "850267",
        "description": "Zapachy inspirowane wakacjami oraz trendami konsumenckimi. Bahama & Co. to nie tylko akcesoria do samochodu, ale również atrakcyjne gadżety, stanowiące element dekoracyjny.",
        "ean": "978020137962",
        "sku": "850267",
        "vat": 23,
        "default_unit_of_measure": "szt.",
        "weight": "0.20",
        "default_price": "25.43"
    },
    {
        "id": 1034,
        "name": "VORTEX TKANINA wielofunkcyjna z mikrofibry /1szt",
        "short_code": "623765",
        "description": "Uniwersalne zastosowanie",
        "ean": "978020137962",
        "sku": "623765",
        "vat": 23,
        "default_unit_of_measure": "op.",
        "weight": "0.38",
        "default_price": "31.52"
    },
    {
        "id": 951,
        "name": "CALIFORNIA zapach samochodowy SCENT CONTROL Ice /1szt",
        "short_code": "851233",
        "description": "Papierowe zawieszki zapachowe: \nInnowacyjna technologia dostosowania intensywności zapachu – wystarczy odpowiednio ustawić zawieszkę. \nPapier pokryty zapachowymi olejkami.\nW zestawie sznurek umożliwiający wygodne zawieszanie zapachu. \nDostępne zapachy: Coronado cherry; Ice; New Car; Sea Breeze",
        "ean": "978020137962",
        "sku": "851233",
        "vat": 23,
        "default_unit_of_measure": "szt.",
        "weight": "0.33",
        "default_price": "18.38"
    },
 ]

Available methods

Here is a list of available methods.
HTTP method that is allowed: GET

Products

With this method you can get list of products.

Methods

URL	HTTP allowed method	Description
/external/v1/products/	GET	get list of products
/external/v1/products/{id}/	GET	get product by ID

Categories

With this method you can get list of categories.

Methods

URL	HTTP allowed method	Description
/external/v1/categories/	GET	get list of categories
/external/v1/categories/{id}/	GET	get category by ID

Relation between Product and Categories

This method returns all bindings of product to categories

Methods

URL	HTTP allowed method	Description
/external/v1/product-categories/	GET	list of relations beteen product and category

Product files

This method returns all files attached to product

URL	HTTP allowed method	Description
/external/v1/product-files/	GET	list of files

Stocks

This method returns prodct's stocks