Requisiti¶
Una volta ottenuto il token JWT possiamo procedere con il recupero di tutti i dati necessari per l'avvio di una procedura Sign.
Info
Per ottenere il token JWT visita la sezione Sicurezza.
I dati da raccogliere utili all'avvio di una procedura Sign sono:
Terne e Tipo di procedura¶
Per poter ricevere le seguenti liste è bisogna effettuare una richiesta API verso il seguente endpoint:
/api/v2/products/contractTypesRestituisce una lista di combinazioni di categorie prodotti e sottoprodotti per banca
Richiede autenticazione (token Bearer).
Parametri¶
| Nome | Posizione | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|---|
procedureTypes |
query | array[integer (int32)] | No |
Risposte¶
| Codice | Descrizione |
|---|---|
200 |
Success |
401 |
Unauthorized |
403 |
Forbidden |
Risposta 200 · CategoryContractTypeOIEnumerableLsWebResponse
{
"error": {
"httpStatusCode": 100,
"level": 0,
"levelName": "string",
"message": "string",
"stackTrace": "string",
"exceptionMessage": "string"
},
"response": {
"level": 0,
"levelName": "string",
"message": "string",
"data": [
{
"categoryId": 0,
"categoryDescription": "string",
"products": [
{
"productId": 0,
"productDescription": "string",
"subProducts": [
{
"subProductId": 0,
"subProductDescription": "string",
"procedureType": 2
}
]
}
]
}
]
}
}
Numero massimo di firmatari per la terna selezionata¶
Nel caso una terna (categoryId, productId e subProductId) selezionata avesse dei documenti Template configurati per la firma di N firmatari, questa API ti fornirà il numero esatto di firmatari richiesti per il completamento di questa procedura.
/api/v2/procedures/signersRestituisce il numero massimo di firmatari per le procedure di quella Categoria/Prodotto/Sottoprodotto
Richiede autenticazione (token Bearer).
Parametri¶
| Nome | Posizione | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|---|
categoryId |
query | integer (int32) | No | |
productId |
query | integer (int32) | No | |
subProductId |
query | integer (int32) | No |
Risposte¶
| Codice | Descrizione |
|---|---|
200 |
Success |
401 |
Unauthorized |
403 |
Forbidden |
Risposta 200 · MaxSignersOLsWebResponse
Recupero dei dettagli dei template di una terna¶
I dati ottenuti dalla seguente api ci forniranno il guid (sarà utile per il recupero del file stesso) dei template oltre ad altre informazioni aggiuntive
/api/v2/products/templatesRestituisce una lista di documenti Template relativi ad una fase di firma di una categoria, prodotto e sottoprodotto di una certa banca
Richiede autenticazione (token Bearer).
Parametri¶
| Nome | Posizione | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|---|
categoryId |
query | integer (int32) | No | |
productId |
query | integer (int32) | No | |
subProductId |
query | integer (int32) | No |
Risposte¶
| Codice | Descrizione |
|---|---|
200 |
Success |
401 |
Unauthorized |
403 |
Forbidden |
Risposta 200 · TemplateOIEnumerableLsWebResponse
{
"error": {
"httpStatusCode": 100,
"level": 0,
"levelName": "string",
"message": "string",
"stackTrace": "string",
"exceptionMessage": "string"
},
"response": {
"level": 0,
"levelName": "string",
"message": "string",
"data": [
{
"guid": "string",
"name": "string",
"filename": "string",
"uploadRequired": true,
"pages": 0,
"precompilable": true,
"toCompile": true
}
]
}
}
Recupero del blob di un template specifico¶
Mediante un guid (ricevuto in risposta dall'API precedentemente indicata) si potrà ottenere il blob del documento template scelto
/api/v2/file/document/requiredPermette di scaricare i template vuoti
Richiede autenticazione (token Bearer).
Parametri¶
| Nome | Posizione | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|---|
guid |
query | string | No |
Risposte¶
| Codice | Descrizione |
|---|---|
200 |
Success |
401 |
Unauthorized |
403 |
Forbidden |