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 для самоконтролю. Зміна формату не витрачає додаткову квоту: одна генерація = один запит.

⚠️ Коди помилок