API-документация для генерации подписей

⚡ Быстрый старт

Три шага от регистрации до первой подписи.

🔗 Базовый адрес

Все ответы — JSON. При успехе: { "success": true, "data": {…}, "meta": {…} }; при ошибке: { "success": false, "error": { "code", "message" } }.

https://onlinesignatures.net/api/v1

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

В каждом запросе нужен Bearer-токен в заголовке Authorization. Ключи создаются и управляются на странице API в кабинете — полный ключ показывается только один раз.

curl https://onlinesignatures.net/api/v1/usage \
  -H "Authorization: Bearer sk_live_your_token"

🎨 Форматы вывода

По умолчанию подпись возвращается в PNG с прозрачным фоном. Добавьте параметр format, чтобы получить другой формат — это не расходует дополнительную квоту.

Ключи — сколько API-ключей можно создать на этом тарифе. Запросов / месяц — основная квота; запросов / минуту — защита от всплесков.

🔍 Качество изображения

По умолчанию подпись возвращается в стандартном качестве (1×). Добавьте параметр quality, чтобы получить более крупное и чёткое изображение: 2× — вдвое больше пикселей, 4× — вчетверо. Дополнительный лимит не расходуется.

curl -X POST https://onlinesignatures.net/api/v1/signatures \
 -H "Authorization: Bearer sk_live_..." \
 -H "Content-Type: application/json" \
 -d '{"first_name":"Signature",
      "last_name":"Generator",
      "format":"png",
      "quality":4}'

Та же подпись в другом качестве

Чтобы получить ту же самую подпись в другом качестве, сохраните hash из ответа и запросите её снова через POST /api/v1/signatures/replay. Каждый вызов — один запрос.

curl -X POST https://onlinesignatures.net/api/v1/signatures/replay \
 -H "Authorization: Bearer sk_live_..." \
 -H "Content-Type: application/json" \
 -d '{"hash":"eyJpdiI6...",
      "format":"png",
      "quality":4}'

Сгенерировать новую подпись по имени и фамилии.

curl -X POST https://onlinesignatures.net/api/v1/signatures \
 -H "Authorization: Bearer sk_live_..." \
 -H "Content-Type: application/json" \
 -d '{"first_name":"Signature",
      "last_name":"Generator"}'

curl -X POST https://onlinesignatures.net/api/v1/signatures \
 -H "Authorization: Bearer sk_live_..." \
 -H "Content-Type: application/json" \
 -d '{"first_name":"Signature",
      "last_name":"Generator",
      "format":"pdf"}'

Параметры

{
  "success": true,
  "data": {
    "id": 1842,
    "hash": "eyJpdiI6...",
    "format": "pdf",
    "mime": "application/pdf",
    "signature": "data:application/pdf;
       base64,JVBER..."
  },
  "meta": { "quota": { "remaining":179 } }
}

{
  "success": false,
  "error": {
    "code": "format_not_allowed",
    "message": "The pdf format is
      not available on
      your plan."
  }
}

Повторно отрисовать ранее созданную подпись по её hash. Формат тоже можно указать через ?format=.

curl "https://onlinesignatures.net/api/v1/signatures/{hash}?format=svg" \
  -H "Authorization: Bearer sk_live_your_token"

Возвращает тариф, доступные форматы, месячный лимит, израсходованное количество и время сброса.

{
  "success": true,
  "data": {
    "plan": "Business",
    "formats": ["png", "svg", "jpg"],
    "rate_per_minute": 1000,
    "key": { "name": "Production", "masked": "sk_live_a1b2…8f9c" },
    "quota": { "limit": 500, "used": 321, "remaining": 179 }
  }
}

⏱️ Лимиты и квота

Месячная квота — основной лимит и зависит от тарифа (см. API-тарифы). Дополнительно действует ограничение частоты запросов в минуту (тоже по тарифу) — защита от резких всплесков. В ответах есть заголовки X-Quota-Limit, X-Quota-Remaining и X-Quota-Reset для самоконтроля. Смена формата не тратит дополнительную квоту: одна генерация = один запрос.

⚠️ Коды ошибок