Tabella dei contenuti
Come presentare una finalità tramite API
L'utilizzo di una finalità (Purpose) richiede la creazione di una bozza corredata dall'analisi del rischio, e una successiva attivazione.
Step 1 - Creare la Purpose in DRAFT
La Purpose deve essere creata indicando l'e-service verso il quale verrà utilizzata, le informazioni della finalità, la stima di carico e l'analisi del rischio.
Request
1POST /purposes
2
3{
4 "eserviceId": "fd7d6c6b-c042-4d9c-926a-d5e26c815220",
5 "riskAnalysisForm": {
6 version: 1,
7 answers: [{...}]
8 },
9 "title": "Fruizione del servizio XYZ per norma ABC",
10 "description": "<Descrizione estesa della Finalità>",
11 "isFreeOfCharge": true,
12 "freeOfChargeReason": "Sono una Pubblica Amministrazione",
13 "dailyCalls": "1000"
14}
15Nota: attraverso il back office di PDND Interoperabilità è disponibile uno strumento per sviluppatori che permette di generare il valore del campo riskAnalysisForm a partire dalla compilazione visuale del form. È disponibile sotto Tool per lo sviluppo > Export analisi del rischio.
La richiesta di creazione, se andata a buon fine, produce una Purpose con una versione in bozza.
Response
1{
2 "id": "17bfba0b-85f2-44e1-9bfc-497605a0d8c7",
3 "eserviceId": "fd7d6c6b-c042-4d9c-926a-d5e26c815220",
4 "consumerId": "efea2507-08df-4a5d-b4bf-263763ae03ad",
5 "title": "Fruizione del servizio XYZ per norma ABC",
6 "description": "<Descrizione estesa della Finalità>",
7 "createdAt": "2025-06-01T00🕛️34Z",
8 "isRiskAnalysisValid": true,
9 "isFreeOfCharge": true,
10 "freeOfChargeReason": "Sono una Pubblica Amministrazione",
11 "currentVersion": {
12 "id": "b9297a6e-2d8a-4b43-b1e6-a1c74d55f1ea",
13 "state": "DRAFT",
14 "createdAt": "2025-06-01T00🕛️34Z",
15 "dailyCalls": "1000"
16 }
17}
18Step 2 - Attivazione della Purpose
Completata la compilazione, è necessario sottomettere la Purpose per poterla attivare.
Request
1POST /purposes/17bfba0b-85f2-44e1-9bfc-497605a0d8c7/activate
2
3{}
4Caso 1 - Stima di carico inferiore alle soglie massime
Se la stima di carico è inferiore alle soglie previste dalla versione dell'e-service (EServiceDescriptor), la Purpose viene attivata.
Response
1{
2 "id": "17bfba0b-85f2-44e1-9bfc-497605a0d8c7",
3 "eserviceId": "fd7d6c6b-c042-4d9c-926a-d5e26c815220",
4 "consumerId": "efea2507-08df-4a5d-b4bf-263763ae03ad",
5 "title": "Fruizione del servizio XYZ per norma ABC",
6 "description": "<Descrizione estesa della Finalità>",
7 "createdAt": "2025-06-01T00🕛️34Z",
8 "updatedAt": "2025-06-02T00🕛️34Z",
9 "isRiskAnalysisValid": true,
10 "isFreeOfCharge": true,
11 "freeOfChargeReason": "Sono una Pubblica Amministrazione",
12 "currentVersion": {
13 "id": "b9297a6e-2d8a-4b43-b1e6-a1c74d55f1ea",
14 "state": "ACTIVE",
15 "createdAt": "2025-06-01T00🕛️34Z",
16 "updatedAt": "2025-06-02T00🕛️34Z",
17 "dailyCalls": "1000"
18 }
19}
20Caso 2 - Stima di carico superiore alle soglie massime
Se la stima di carico è superiore alle soglie previste dalla versione dell'e-service (EServiceDescriptor), la Purpose passa in attesa di approvazione e richiede la conferma da parte dell'erogatore.
Response
1{
2 "id": "17bfba0b-85f2-44e1-9bfc-497605a0d8c7",
3 "eserviceId": "fd7d6c6b-c042-4d9c-926a-d5e26c815220",
4 "consumerId": "efea2507-08df-4a5d-b4bf-263763ae03ad",
5 "title": "Fruizione del servizio XYZ per norma ABC",
6 "description": "<Descrizione estesa della Finalità>",
7 "createdAt": "2025-06-01T00🕛️34Z",
8 "updatedAt": "2025-06-02T00🕛️34Z",
9 "isRiskAnalysisValid": true,
10 "isFreeOfCharge": true,
11 "freeOfChargeReason": "Sono una Pubblica Amministrazione",
12 "waitingForApprovalVersion": {
13 "id": "b9297a6e-2d8a-4b43-b1e6-a1c74d55f1ea",
14 "state": "WAITING_FOR_APPROVAL",
15 "createdAt": "2025-06-01T00🕛️34Z",
16 "updatedAt": "2025-06-02T00🕛️34Z",
17 "dailyCalls": "1000"
18 }
19}
20Pagina successiva → Come aggiornare la stima di carico di una finalità tramite API
Hai bisogno di aiuto?
Apri un ticket utilizzando l’apposita funzione all’interno della tua Area Riservata
