Macma API

Wprowadzenie do API

API jest to interfejs programistyczny aplikacji (ang. Application Programming Interface, API) – sposób, rozumiany jako ściśle określony zestaw metod i ich opisów, w jaki programy komunikują się między sobą. API definiuje się na poziomie kodu źródłowego dla takich składników oprogramowania jak np. aplikacje, biblioteki czy system operacyjny. Zadaniem API jest dostarczenie odpowiednich specyfikacji podprogramów, struktur danych, klas obiektów i wymaganych protokołów komunikacyjnych.

Klucz API

Do korzystania z Macma API, niezbędny jest tzw. klucz. Jest to ciąg znaków autentykujący użytkownika (agencję). Aby wygenerować swój własny klucz API, należy zalogować się do profilu na stronie www.macma.pl i przejść do pozycji w menu: API.

UWAGA: Nie przekazuj osobom trzecim swojego klucza API. Klucz API identyfikuje firmę i wszelkie operacje wykonane za jego pomocą, takie jak kalkulacje czy kupno towaru.

Metody

W lewym menu dostępne są szczegółowe wyjaśnienia dotyczące udostępnionych metod. Dla każdej z metod opisane są wymagane atrybuty, oraz podane przykłady wywołania. W razie pytań i uwag, prosimy kontaktować się pod tym adresem e-mail: api@macma.pl, lub za pomocą poniższego formularza.

Metoda: brands

Opis Metoda służąca do pozyskania listy marek w sklepie Macma Webshop.
Dzienny limit 24
Wywołanie funkcji http://api.macma.pl/<lang>/<apikey>/brands/
Wywołanie funkcji z wynikiem json http://api.macma.pl/<lang>/<apikey>/brands/json
Wartość domyślna dla <lang>: pl
Metoda zapytania: GET
Przykładowe wywołanie: define(API_KEY, 'xxxxxxxxxxxxxxxxx');
$url = 'http://api.macma.pl/pl/' . API_KEY . '/brands/';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
$result = curl_exec($ch);
curl_close($ch);

Metoda: calculate

Opis Metoda służąca do kalkulacji kosztów produktu z/bez znakowania.
Dzienny limit 480
Wywołanie funkcji http://api.macma.pl/<lang>/<apikey>/calculate/
Wywołanie funkcji z wynikiem json http://api.macma.pl/<lang>/<apikey>/calculate/json
Wartość domyślna dla <lang>: pl
Metoda zapytania: POST
Parametr calctype: withmarking lub nomarking
Przykładowe wywołanie: define(API_KEY, 'xxxxxxxxxxxxxxxxx');

$url = 'http://api.macma.pl/pl/' . API_KEY . '/calculate/';

/* dla jednego logotypu */
$fields = array(
    'pid' => 1,
    'quantity' => 100,
    'calctype' => 'withmarking',
    'logos' => 1,
    'marking1' => 6,
    'colors1' => 1,
    'places1' => 1
);
/* dla dwóch logotypów */
$fields = array(
    'pid' => 1,
    'quantity' => 100,
    'calctype' => 'withmarking',
    'logos' => 2,
    'marking1' => 6,
    'colors1' => 1,
    'places1' => 1
    'marking2' => 6,
    'colors2' => 1,
    'places2' => 1
);
$post_fields = array('fields' => serialize($fields));

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, count($fields));
curl_setopt($ch, CURLOPT_POSTFIELDS, $post_fields);
$result = curl_exec($ch);
curl_close($ch);

Metoda: categories

Opis Metoda służąca do pozyskania listy kategorii w sklepie Macma Webshop.
Dzienny limit 24
Wywołanie funkcji http://api.macma.pl/<lang>/<apikey>/categories/
Wywołanie funkcji z wynikiem json http://api.macma.pl/<lang>/<apikey>/categories/json
Wartość domyślna dla <lang>: pl
Metoda zapytania: GET
Przykładowe wywołanie: define(API_KEY, 'xxxxxxxxxxxxxxxxx');
$url = 'http://api.macma.pl/pl/' . API_KEY . '/categories/';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
$result = curl_exec($ch);
curl_close($ch);

Metoda: colors

Opis Metoda służąca do pozyskania listy kolorów w sklepie Macma Webshop.
Dzienny limit 24
Wywołanie funkcji http://api.macma.pl/<lang>/<apikey>/colors/
Wywołanie funkcji z wynikiem json http://api.macma.pl/<lang>/<apikey>/colors/json
Wartość domyślna dla <lang>: pl
Metoda zapytania: GET
Przykładowe wywołanie: define(API_KEY, 'xxxxxxxxxxxxxxxxx');
$url = 'http://api.macma.pl/pl/' . API_KEY . '/colors/';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
$result = curl_exec($ch);
curl_close($ch);

Metoda: markgroups

Opis Metoda służąca do pozyskania listy znakowań w sklepie Macma Webshop.
Dzienny limit 24
Wywołanie funkcji http://api.macma.pl/<lang>/<apikey>/markgroups/
Wywołanie funkcji z wynikiem json http://api.macma.pl/<lang>/<apikey>/markgroups/json
Wartość domyślna dla <lang>: pl
Metoda zapytania: GET
Przykładowe wywołanie: define(API_KEY, 'xxxxxxxxxxxxxxxxx');
$url = 'http://api.macma.pl/pl/' . API_KEY . '/markgroups/';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
$result = curl_exec($ch);
curl_close($ch);

Metoda: materials

Opis Metoda służąca do pozyskania listy materiałów w sklepie Macma Webshop.
Dzienny limit 24
Wywołanie funkcji http://api.macma.pl/<lang>/<apikey>/materials/
Wywołanie funkcji z wynikiem json http://api.macma.pl/<lang>/<apikey>/materials/json
Wartość domyślna dla <lang>: pl
Metoda zapytania: GET
Przykładowe wywołanie: define(API_KEY, 'xxxxxxxxxxxxxxxxx');
$url = 'http://api.macma.pl/pl/' . API_KEY . '/materials/';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
$result = curl_exec($ch);
curl_close($ch);

Metoda: packages

Opis Metoda służąca do pozyskania listy opakowań w sklepie Macma Webshop.
Dzienny limit 24
Wywołanie funkcji http://api.macma.pl/<lang>/<apikey>/packages/
Wywołanie funkcji z wynikiem json http://api.macma.pl/<lang>/<apikey>/packages/json
Wartość domyślna dla <lang>: pl
Metoda zapytania: GET
Przykładowe wywołanie: define(API_KEY, 'xxxxxxxxxxxxxxxxx');
$url = 'http://api.macma.pl/pl/' . API_KEY . '/packages/';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
$result = curl_exec($ch);
curl_close($ch);

Metoda: product

Opis Metoda służąca do pozyskania szczegółów produktu w sklepie Macma Webshop.
Dzienny limit 5 000
Wywołanie funkcji http://api.macma.pl/<lang>/<apikey>/product/<id>/
Wywołanie funkcji z wynikiem json http://api.macma.pl/<lang>/<apikey>/product/<id>/json
Wartość domyślna dla <lang>: pl
Metoda zapytania: GET
Przykładowe wywołanie: define(API_KEY, 'xxxxxxxxxxxxxxxxx');
$url = 'http://api.macma.pl/pl/' . API_KEY . '/product/1/';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
$result = curl_exec($ch);
curl_close($ch);

Metoda: products

Opis Metoda służąca do pozyskania listy produktów w sklepie Macma Webshop.
Dzienny limit 24
Wywołanie funkcji http://api.macma.pl/<lang>/<apikey>/products/
Wywołanie funkcji z wynikiem json http://api.macma.pl/<lang>/<apikey>/products/json
Wartość domyślna dla <lang>: pl
Metoda zapytania: GET
Przykładowe wywołanie: define(API_KEY, 'xxxxxxxxxxxxxxxxx');
$url = 'http://api.macma.pl/pl/' . API_KEY . '/products/';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
$result = curl_exec($ch);
curl_close($ch);

Metoda: promotions

Opis Metoda służąca do pozyskania listy promocji w sklepie Macma Webshop.
Dzienny limit 24
Wywołanie funkcji http://api.macma.pl/<lang>/<apikey>/promotions/
Wywołanie funkcji z wynikiem json http://api.macma.pl/<lang>/<apikey>/promotions/json
Wartość domyślna dla <lang>: pl
Metoda zapytania: GET
Przykładowe wywołanie: define(API_KEY, 'xxxxxxxxxxxxxxxxx');
$url = 'http://api.macma.pl/pl/' . API_KEY . '/promotions/';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
$result = curl_exec($ch);
curl_close($ch);

Metoda: quantity

Opis Metoda służąca do pozyskania stanów magazynowych produktu w sklepie Macma Webshop.
Dzienny limit 480
Wywołanie funkcji http://api.macma.pl/<lang>/<apikey>/quantity/<id>/
Wywołanie funkcji z wynikiem json http://api.macma.pl/<lang>/<apikey>/quantity/<id>/json
Wartość domyślna dla <lang>: pl
Metoda zapytania: GET
Przykładowe wywołanie: define(API_KEY, 'xxxxxxxxxxxxxxxxx');
$url = 'http://api.macma.pl/pl/' . API_KEY . '/quantity/1/';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
$result = curl_exec($ch);
curl_close($ch);

Metoda: sets

Opis Metoda służąca do pozyskania listy kategorii tematycznych w sklepie Macma Webshop.
Dzienny limit 24
Wywołanie funkcji http://api.macma.pl/<lang>/<apikey>/sets/
Wywołanie funkcji z wynikiem json http://api.macma.pl/<lang>/<apikey>/sets/json
Wartość domyślna dla <lang>: pl
Metoda zapytania: GET
Przykładowe wywołanie: define(API_KEY, 'xxxxxxxxxxxxxxxxx');
$url = 'http://api.macma.pl/pl/' . API_KEY . '/sets/';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
$result = curl_exec($ch);
curl_close($ch);

Metoda: stocks

Opis Metoda służąca do pozyskania stanów magazynowych wszystkich produktów w sklepie Macma Webshop.
Dzienny limit 480
Wywołanie funkcji http://api.macma.pl/<lang>/<apikey>/stocks
Wywołanie funkcji z wynikiem json http://api.macma.pl/<lang>/<apikey>/stocks/json
Wartość domyślna dla <lang>: pl
Metoda zapytania: GET
Przykładowe wywołanie: define(API_KEY, 'xxxxxxxxxxxxxxxxx');
$url = 'http://api.macma.pl/pl/' . API_KEY . '/stocks';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
$result = curl_exec($ch);
curl_close($ch);
Back to Top