Документация API

Введение

ApiNex Gateway предоставляет единый RESTful API для взаимодействия со всеми подключёнными сервисами. Базовый URL: https://api.apinex.online/v1

Все запросы должны выполняться по протоколу HTTPS с использованием TLS 1.3. Поддерживаются методы GET, POST, PUT, PATCH, DELETE.

Аутентификация

Для аутентификации используется Bearer-токен, который можно получить в личном кабинете.

Authorization: Bearer sk_live_51HbYourTokenHere

⚠️ Важно: Никогда не публикуйте секретные ключи в публичных репозиториях. Используйте переменные окружения.

Основной endpoint

Все интеграции выполняются через единый endpoint:

POST https://api.apinex.online/v1/gateway

Формат запросов

Запросы отправляются в формате JSON. Обязательные поля:

{
  "route": "crm.salesforce.sync",
  "payload": {
    "account_id": "acc_9921",
    "fields": {
      "name": "ООО Ромашка",
      "email": "info@example.ru"
    }
  },
  "options": {
    "async": true,
    "retry": 3
  }
}

Формат ответов

Все ответы возвращаются в формате JSON с единой структурой:

{
  "success": true,
  "request_id": "req_7f3a9b2c",
  "data": { ... },
  "meta": {
    "latency_ms": 47,
    "route_version": "2024.03"
  }
}

Коды ошибок

Код	Описание
`400`	Неверный формат запроса
`401`	Неверный или отсутствующий токен
`403`	Нет прав для выполнения операции
`404`	Route не найден
`429`	Превышен лимит запросов
`500`	Внутренняя ошибка сервера

SDK и библиотеки

Официальные SDK для популярных языков:

🐍

Python

pip install apinex

📦

Node.js

npm i @apinex/sdk

🐘

PHP

composer require apinex/sdk

☕

Java

Maven / Gradle

Вебхуки

Получайте уведомления о событиях в вашем аккаунте через HTTP POST-запросы. Все вебхуки подписываются HMAC-SHA256.

// Проверка подписи вебхука (Node.js)
const crypto = require('crypto');
const signature = crypto
  .createHmac('sha256', process.env.WEBHOOK_SECRET)
  .update(rawBody)
  .digest('hex');