API - Подключение и авторизация

Аутентификация и базовый URL

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

Создайте учётные данные API в настройках интернет-магазина. Токен доступа показывается только один раз, поэтому сразу сохраните его в защищённом хранилище секретов на сервере.

Храните ключ и токен доступа на своём сервере. Конечные точки с аутентификацией отклоняют вызовы из браузера с заголовками Origin или Referer.

Учётным данным можно назначить ограниченные права. Используйте GET /auth/check для проверки активного магазина, возможностей тарифа и прав, возвращаемых для учётных данных.

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

Проверка подключения

Проверяйте аутентификацию через соответствующую конечную точку перед включением синхронизации или встраивания в рабочей интеграции.

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

Пример запроса (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);

Пример ответа

{
  "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
    }
  }
}

Вспомогательная функция ниже используется в остальных примерах. Она основана на обычном fetch и работает в Node.js 18+ или любой серверной среде, предоставляющей 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;
}

Ошибки и ограничения частоты запросов

Большинство ошибок контроллеров нормализуется в ответ code. Промежуточные обработчики аутентификации и ограничители частоты могут вместо этого возвращать ответ error.

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

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

{
  "error": "Too Many Requests"
}