DevPortalPagoPA

SoluzioniWebinar
Tabella dei contenuti

Come presentare una richiesta di fruizione tramite API

La presentazione di una richiesta di fruizione (Agreement) prevede la creazione di una bozza, seguita da una sottomissione.

Step 1 - Creare l'Agreement in DRAFT

L'Agreement deve essere creato indicando sia l'e-service che la specifica versione di e-service (EServiceDescriptor) a cui fa riferimento.
Request
1POST /agreements
2
3{
4    "eserviceId": "fd7d6c6b-c042-4d9c-926a-d5e26c815220",
5    "descriptorId": "419adb1c-8e0e-4225-97d9-24510a9a4aac"
6}
7
La richiesta di creazione, se andata a buon fine, produce un Agreement in bozza.
Response
1{
2    "id": "17bfba0b-85f2-44e1-9bfc-497605a0d8c7",
3    "eserviceId": "fd7d6c6b-c042-4d9c-926a-d5e26c815220",
4    "descriptorId": "419adb1c-8e0e-4225-97d9-24510a9a4aac",
5    "producerId": "90f45b0c-f63b-4a16-9352-80497ee88890",
6    "consumerId": "efea2507-08df-4a5d-b4bf-263763ae03ad",
7    "state": "DRAFT",
8    "createdAt": "2025-06-01T00🕛️34Z"
9}
10

Step 2 - Sottomettere l'Agreement per l'attivazione

La bozza può essere sottomessa per richiederne l'attivazione.
Request
1POST /agreements/17bfba0b-85f2-44e1-9bfc-497605a0d8c7/submit
2
3{}
4

Risposta in caso di requisiti soddisfatti

Se il Fruitore richiedente possiede i requisiti necessari, l'Agreement viene attivato.
Response
1{
2    "id": "17bfba0b-85f2-44e1-9bfc-497605a0d8c7",
3    "eserviceId": "fd7d6c6b-c042-4d9c-926a-d5e26c815220",
4    "descriptorId": "419adb1c-8e0e-4225-97d9-24510a9a4aac",
5    "producerId": "90f45b0c-f63b-4a16-9352-80497ee88890",
6    "consumerId": "efea2507-08df-4a5d-b4bf-263763ae03ad",
7    "state": "ACTIVE",
8    "createdAt": "2025-06-01T00🕛️34Z",
9    "updatedAt": "2025-06-02T00🕛️34Z"
10}
11

Risposta in caso di requisiti non soddisfatti

Se il fruitore richiedente non possiede i requisiti necessari, l'Agreement passa allo stato In attesa di approvazione (PENDING).
Response
1{
2    "id": "17bfba0b-85f2-44e1-9bfc-497605a0d8c7",
3    "eserviceId": "fd7d6c6b-c042-4d9c-926a-d5e26c815220",
4    "descriptorId": "419adb1c-8e0e-4225-97d9-24510a9a4aac",
5    "producerId": "90f45b0c-f63b-4a16-9352-80497ee88890",
6    "consumerId": "efea2507-08df-4a5d-b4bf-263763ae03ad",
7    "state": "PENDING",
8    "createdAt": "2025-06-01T00🕛️34Z",
9    "updatedAt": "2025-06-02T00🕛️34Z"
10}
11
Pagina successiva → Come presentare una finalità tramite API

In questa pagina

Step 1 - Creare l'Agreement in DRAFT

Step 2 - Sottomettere l'Agreement per l'attivazione

Hai bisogno di aiuto?

Apri un ticket utilizzando l’apposita funzione all’interno della tua Area Riservata

Dicci cosa ne pensi

Per segnalare problemi o dare feedback, puoi aprire una segnalazione su Github