Signer Read

API di lettura per il servizio dei firmatari per Agyo Firma

Swagger ambienti

Descrizione API

Signer Search

POST /v1/rest/signers/search

Permette di recuperare i firmatari di una data azienda

Query Params

itemId identificativo dell'azienda di cui si vuole avere i firmatari
page numero di pagina
size numero di elementi per pagina
fullText permette di fare una ricerca filtrata per alcuni dati dei firmatari

La ricerca fullText viene fatta su questi dati dei firmatari

firstName
lastName
fiscalCode
ownerTaxId codice fiscale dell'azienda su cui il firmatario e stato assegnato
ownerVatNumber partita iva dell'azienda su cui il firmatario e stato assegnato
ownerDescription ragione sociale dell'azienda su cui il firmatario e stato assegnato

Response

{
   "page":0,
   "itemsNumberPerPage":2,
   "totalItems":2,
   "totalPages":1,
   "signers":[
      {
         "id":219,
         "fiscalCode":"MNNRFL96D21I829W",
         "firstName":"Raffaele",
         "lastName":"Mainini",
         "sex":"M",
         "email":"rmainini@mondora.com",
         "cellNumber":"",
         "ownerDescription":null,
         "enabled":true,
         "certificates":[
            {
               "id":225,
               "type":"FSM",
               "status":"SUBMISSION_SUCCESS"
            },
            {
               "id":226,
               "type":"FRM",
               "certificateSn":"585",
               "certificateId":"10846",
               "enabled":true,
               "status":"FINAL_SUCCESS",
               "createBy":"rmainini@mondora.com"
            },
            {
               "id":60,
               "type":"FES",
               "enabled":true,
               "status":"ACTIVE"
            },
            {
               "id":81,
               "type":"FEA",
               "enabled":false,
               "documentHubId":"5e9847700e20480006394a98",
               "status":"INIT"
            }
         ],
         "_links":{
            "self":{
               "href":"https://ts-signer-read-api-test.agyo.io/api/v1/rest/signers/219"
            }
         }
      },
      {
         "id":247,
         "fiscalCode":"PNNGNN80A01I829P",
         "firstName":"Giovanni",
         "lastName":"Panni",
         "sex":"M",
         "email":"rmainini@mondora.com",
         "cellNumber":"",
         "ownerDescription":null,
         "enabled":true,
         "certificates":[

         ],
         "_links":{
            "self":{
               "href":"https://ts-signer-read-api-test.agyo.io/api/v1/rest/signers/247"
            }
         }
      }
   ]
}

Retrive Signer

GET /v1/rest/signers/{id}

Permette di recuperare tutte le info riguardanti uno specifico firmatario

id identificativo del firmatario

Response

{
   "id":219,
   "fiscalCode":"MNNRFL96D21I829W",
   "firstName":"Raffaele",
   "lastName":"Mainini",
   "fiscalCountry":"IT",
   "sex":"M",
   "birthCity":"Sondrio",
   "birthCountry":"IT",
   "birthDate":"1996-04-21T00:00:00.000+0000",
   "birthDistrict":"SO",
   "city":"Sondrio",
   "country":"IT",
   "district":null,
   "cap":"23010",
   "address":"Via Fasulla",
   "email":"rmainini@mondora.com",
   "cellNumber":"",
   "ownerTaxId":null,
   "ownerVatNumber":null,
   "ownerDescription":null,
   "documentIssuer":"me",
   "documentNumber":"1234",
   "documentEndDate":"2020-04-30T00:00:00.000+0000",
   "documentType":"Carta d'identità",
   "_links":{
      "self":{
         "href":"https://ts-signer-read-api-test.agyo.io/api/v1/rest/signers/219"
      }
   }
}

Retrive If Signer Exist into Item

GET /api/v1/rest/signers/searchByFiscalCode

Permette di verificare se un determinato firmatario esiste già per un'azienda

Query Params

itemId identificativo dell'azienda di cui si vuole avere i firmatari
fiscalCode codice fiscale del firmatario che si sta controllando

Download Filled/Signed Document

GET /v1/utils/download/document

Permette di scaricare il contratto per i certificati FRM/FSM (Firma elettronica qualificata automatica/Firma elettronica qualificata remota) sia solamente pre compilato sia quello pre compilato e firmato

Query Params

signerId identificativo del firmatario di cui si vuole recuperare il contratto
certType tipologia di certificato FRM o FSM
documentType tipo documento FILLED o SIGNED

Retrive Slot Usage

GET /v1/rest/certificates/slotUsage/{itemId}

Permette di recuperare il conteggio degli slot per i certificati di un'azienda

Query Params

itemId identificativo dell'azienda

Response

{
   "totalFRM":3,
   "freeFRM":2,
   "totalFSM":3,
   "freeFSM":3
}

Retrive Certificate

GET /v1/rest/certificates/searchByFiscalCode *

Permette di recuperare le info di un determinato certificato(FRM/FSM)

Query Params

itemId identificativo dell'azienda
certType tipologia di certificato FRM o FSM
signerFiscalCodecodice fiscale del firmatario *

*verrà modificato perchè non corretto