Documentazione API per la generazione di firme

⚡ Avvio rapido

Tre passi dalla registrazione alla prima firma.

🔗 URL di base

Tutte le risposte sono in JSON. In caso di successo: { "success": true, "data": {…}, "meta": {…} }; in caso di errore: { "success": false, "error": { "code", "message" } }.

https://onlinesignatures.net/api/v1

🔑 Autenticazione

Ogni richiesta richiede un token Bearer nell'intestazione Authorization. Crea e gestisci le chiavi nella pagina API del tuo account: la chiave completa viene mostrata una sola volta.

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

🎨 Formati di output

Per impostazione predefinita la firma viene restituita come PNG trasparente. Aggiungi il parametro format per ottenere un altro formato: non consuma quota aggiuntiva.

Chiavi = quante chiavi API puoi creare con questo piano. Richieste / mese è la quota principale; richieste / minuto è il limite anti-picco.

🔍 Qualità dell’immagine

Per impostazione predefinita la firma viene restituita in qualità standard (1×). Aggiungi il parametro quality per ottenere un’immagine più grande e nitida: 2× ha il doppio dei pixel, 4× il quadruplo. Non consuma quota aggiuntiva.

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

La stessa firma con un’altra qualità

Per ottenere esattamente la stessa firma con una qualità diversa, salva il hash della risposta e richiedila di nuovo con POST /api/v1/signatures/replay. Ogni chiamata è una richiesta.

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

Genera una firma nuova da nome e cognome.

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

Parametri

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

Rigenera una firma creata in precedenza tramite il suo hash. Puoi anche impostare il formato con ?format=.

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

Restituisce il tuo piano, i formati disponibili, il limite mensile, quanto hai usato e quando si azzera.

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

⏱️ Limiti e quota

La quota mensile è il limite principale e dipende dal tuo piano (vedi Piani API). Inoltre un limite al minuto (anch'esso per piano) protegge dai picchi. Le risposte includono gli header X-Quota-Limit, X-Quota-Remaining e X-Quota-Reset per autolimitarti. Cambiare formato non consuma quota aggiuntiva: una generazione = una richiesta.

⚠️ Codici di errore