API - Připojení a autorizace

Ověření a základní URL

https://alterproduct.com/public-api/v1

Přístupové údaje API vytvořte v panelu nastavení e-shopu. Access Token se zobrazí pouze jednou, proto jej ihned uložte do úložiště tajných údajů na backendu.

Uchovávejte Access Key a Access Token na svém serveru. Koncové body vyžadující ověření odmítají volání z prohlížeče obsahující hlavičky Origin nebo Referer.

Přístupové údaje mohou mít omezené rozsahy oprávnění. Pomocí GET /auth/check ověřte aktivní obchod, možnosti tarifu a rozsahy vrácené pro dané přístupové údaje.

x-alter-access-key: YOUR_API_KEY
x-alter-access-token: YOUR_API_TOKEN

Test připojení

Před zapnutím synchronizace nebo vložených nástrojů v produkční integraci použijte koncový bod kontroly ověření.

GET https://alterproduct.com/public-api/v1/auth/check

Příklad požadavku (fetch)

const response = await fetch('https://alterproduct.com/public-api/v1/auth/check', {
  method: 'GET',
  headers: {
    'x-alter-access-key': process.env.ALTER_ACCESS_KEY,
    'x-alter-access-token': process.env.ALTER_ACCESS_TOKEN
  }
});

const payload = await response.json();

if (!response.ok) {
  throw new Error(payload?.code || payload?.error || `Alter API ${response.status}`);
}

console.log(payload);

Příklad odpovědi

{
  "ok": true,
  "message": "success",
  "storefrontId": 12,
  "userOwnerId": 34,
  "credentialId": 56,
  "scopes": ["orders:read", "orders:write", "products:read"],
  "plan": {
    "requiredPlan": "Business",
    "currentPlanName": "Business",
    "eligible": true,
    "runtimeFlags": {
      "viewer": true,
      "configurator": true,
      "customizer": true
    },
    "limits": {
      "activeRuntimeBindingsLimit": 100,
      "monthlyReassignmentLimit": 1000,
      "monthlyEmbedTokenLimit": 50000
    }
  }
}

Níže uvedenou pomocnou funkci používají i zbývající příklady. Jde o běžný fetch a může běžet v Node.js 18+ nebo v libovolném serverovém prostředí s podporou fetch.

const ALTER_API_BASE = 'https://alterproduct.com/public-api/v1';

const authHeaders = {
  'x-alter-access-key': process.env.ALTER_ACCESS_KEY,
  'x-alter-access-token': process.env.ALTER_ACCESS_TOKEN
};

async function alterFetch(path, options = {}) {
  const response = await fetch(`${ALTER_API_BASE}${path}`, {
    ...options,
    headers: {
      ...authHeaders,
      ...(options.body ? { 'Content-Type': 'application/json' } : {}),
      ...options.headers
    }
  });

  const payload = await response.json().catch(() => null);

  if (!response.ok) {
    throw new Error(payload?.code || payload?.error || `Alter API ${response.status}`);
  }

  return payload;
}

Chyby a limity požadavků

Většina chyb řadičů se převádí na odpověď s code. Autentizační middleware a omezovače požadavků mohou místo toho vrátit odpověď s error.

// Controller error
{
  "code": "assetCatalog.invalidType"
}

// Auth middleware or rate limit
{
  "error": "Unauthorized"
}

{
  "error": "Too Many Requests"
}