Dokumentacja API do generowania podpisów

⚡ Szybki start

Trzy kroki od rejestracji do pierwszego podpisu.

🔗 Bazowy adres URL

Wszystkie odpowiedzi są w formacie JSON. Przy powodzeniu: { "success": true, "data": {…}, "meta": {…} }; przy błędzie: { "success": false, "error": { "code", "message" } }.

https://onlinesignatures.net/api/v1

🔑 Uwierzytelnianie

Każde żądanie wymaga tokena Bearer w nagłówku Authorization. Klucze twórz i zarządzaj nimi na stronie API w koncie — pełny klucz jest pokazywany tylko raz.

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

🎨 Formaty wyjściowe

Domyślnie podpis jest zwracany jako przezroczysty PNG. Dodaj parametr format, aby otrzymać inny format — nie zużywa to dodatkowego limitu.

Klucze = ile kluczy API możesz utworzyć w tym planie. Żądań / miesiąc to główny limit; żądań / minutę to ochrona przed skokami.

🔍 Jakość obrazu

Domyślnie podpis jest zwracany w standardowej jakości (1×). Dodaj parametr quality, aby otrzymać większy i ostrzejszy obraz: 2× to dwa razy więcej pikseli, 4× — cztery razy więcej. Nie zużywa dodatkowego limitu.

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}'

Ten sam podpis w innej jakości

Aby otrzymać dokładnie ten sam podpis w innej jakości, zapisz hash z odpowiedzi i poproś o niego ponownie przez POST /api/v1/signatures/replay. Każde wywołanie to jedno żądanie.

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}'

Wygeneruj nowy podpis na podstawie imienia i nazwiska.

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

Parametry

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

Wygeneruj ponownie wcześniej utworzony podpis na podstawie jego hash. Format możesz też ustawić przez ?format=.

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

Zwraca Twój plan, dostępne formaty, miesięczny limit, zużycie oraz czas resetu.

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

⏱️ Limity i przydział

Miesięczny limit jest głównym ograniczeniem i zależy od planu (zob. Plany API). Dodatkowo limit na minutę (również według planu) chroni przed skokami. Odpowiedzi zawierają nagłówki X-Quota-Limit, X-Quota-Remaining i X-Quota-Reset do samoograniczania. Zmiana formatu nie zużywa dodatkowego limitu: jedna generacja = jedno żądanie.

⚠️ Kody błędów