REST API
Complete REST interface for all resources
See documentation
Template API
Smarty classes and methods
See reference
OAuth 2.0
Secure app integration
OAuth guide
Webhooks
Real-time event notifications
Coming soon
Get started quickly
1 Create API key
Log in to your online shop admin and navigate to Settings → API access. Here you can create a new API key with the necessary rights.
# Example API key
5d41402abc4b2a76b9719d911017c592
2 Make your first API call
Test your connection with a simple GET request to the product endpoint:
curl -X GET /api/v1/products \
-H "Authorization: Bearer 5d41402abc4b2a76b9719d911017c592" \
-H "Accept: application/json"3 Explore the API
Now you're ready to explore all the possibilities in our API:
Code examples
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "/api/v1/products");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Bearer 5d41402abc4b2a76b9719d911017c592",
"Accept: application/json"
]);
$response = curl_exec($ch);
$products = json_decode($response, true);
curl_close($ch);
?>
JavaScript
const response = await fetch('/api/v1/products', {
method: 'GET',
headers: {
'Authorization': 'Bearer 5d41402abc4b2a76b9719d911017c592',
'Accept': 'application/json'
}
});
const products = await response.json();
console.log(products);
Python
import requests
headers = {
'Authorization': 'Bearer 5d41402abc4b2a76b9719d911017c592',
'Accept': 'application/json'
}
response = requests.get(
'/api/v1/products',
headers=headers
)
products = response.json()
print(products)
C# / .NET
using (var client = new HttpClient())
{
client.DefaultRequestHeaders.Add("Authorization", "Bearer 5d41402abc4b2a76b9719d911017c592");
client.DefaultRequestHeaders.Add("Accept", "application/json");
var response = await client.GetAsync("/api/v1/products");
var json = await response.Content.ReadAsStringAsync();
var products = JsonSerializer.Deserialize<List<Product>>(json);
}