OpenAPI / Swagger
Askme Sign espone una specifica OpenAPI 2.0 (Swagger) che documenta tutti gli endpoint disponibili, i modelli di dati, i parametri e le risposte. Questa specifica può essere usata per generare client SDK, testare le API e consultare la documentazione tecnica completa.
Specifica OpenAPI
La specifica è disponibile come file JSON:
https://docs.askme.it/api-docs-sign.json
Il file è incluso anche nel repository della documentazione in static/api-docs-sign.json.
Come Utilizzare la Specifica
Swagger UI
Puoi visualizzare e testare le API direttamente nel browser:
- Apri Swagger Editor
- Seleziona File > Import URL
- Incolla l'URL della specifica:
https://docs.askme.it/api-docs-sign.json - Naviga tra gli endpoint, visualizza i modelli e testa le chiamate
Generazione Client SDK
La specifica OpenAPI può essere usata per generare automaticamente client SDK in diversi linguaggi tramite OpenAPI Generator:
# Java
openapi-generator-cli generate -i api-docs-sign.json -g java -o ./sdk-java
# Python
openapi-generator-cli generate -i api-docs-sign.json -g python -o ./sdk-python
# TypeScript
openapi-generator-cli generate -i api-docs-sign.json -g typescript-fetch -o ./sdk-typescript
Postman
Per importare la collezione in Postman:
- Apri Postman
- Seleziona Import > Link
- Incolla l'URL della specifica
- Configura le variabili di ambiente (
X-SignToken,X-SignUser,baseUrl)
Autenticazione nella Specifica
La specifica definisce i seguenti schemi di autenticazione:
- API Key (header):
X-SignToken— Token API per l'autenticazione - Basic Auth: autenticazione HTTP Basic (username/password)
Tag Principali
La specifica organizza gli endpoint per tag. I tag più rilevanti per le integrazioni sono:
| Tag | Descrizione | Endpoint principali |
|---|---|---|
| Files | Gestione pratiche di firma | Creazione, elenco, dettaglio, download, eliminazione |
| Documents | Gestione singoli documenti | Upload, viewer, download |
| Account | Informazioni utente | Verifica account, profilo |
| Workflows | Gestione workflow | Tipologie di processo, flussi |
| Contacts | Rubrica contatti | CRUD contatti |
| Configurations | Configurazione tenant | Impostazioni, certificati |
Per l'elenco completo dei tag e degli endpoint, consultare direttamente la specifica OpenAPI.