Definizione API PDND Connector

Endpoint del pdnd-connector

Il pdnd-connector espone endpoint specifici per ciascun e-service integrato, con diverse operazioni supportate tramite verbi HTTP.

Endpoint di Chiamata

Gli endpoint seguono una struttura che identifica l'erogatore e il servizio specifico. Ad esempio, per gli e-service ANPR (ANPR è l'erogatore), si utilizzano path come /e-services/anpr/<nome-e-service>. Esempi di <nome-e-service> includono accertamento-cittadinanza, stato-famiglia, accertamento-residenza.

Verbi HTTP Utilizzati

• GET: Utilizzato per la fruizione degli e-service, ovvero per richiedere e ottenere i dati dal pdnd-connector, che a sua volta li recupera dagli enti erogatori (es. ANPR, INPS).

• POST: Utilizzato per la validazione dei dati precedentemente ottenuti tramite GET. Questa operazione verifica che i dati non siano stati alterati prima di essere inviati dal Core.

• Parametri Richiesti (Payload per POST, URL per GET):

  • Per GET (Fruizione): I parametri sono inclusi nella URL (query parameters). Esempi includono:

    • fiscalCode: Il codice fiscale dell'utente di cui si richiedono i dati.

    • format: Un parametro che specifica il formato in cui i dati devono essere restituiti dal pdnd-connector. Questo formato deve essere compatibile con il Nested Form di OpenCity che riceverà i dati.

    • Esempio URL: GET /e-services/anpr/stato-famiglia?fiscalCode=ABCDEF01G23H456I&format=statoFamigliaArchetipo

  • Per POST (Validazione): Il payload della richiesta POST deve contenere due campi principali:

    • data: L'oggetto JSON contenente i dati esatti (incluso il loro formato) così come ricevuti dalla risposta GET precedente, senza i metadati di isFromPdnd, isReadonly, isUpdatedToday.

    • meta: Un oggetto contenente la firma digitale (signature) dei dati, così come restituita dalla risposta GET.

• Header Necessari: Per tutte le chiamate agli endpoint del pdnd-connector, è necessario includere un token JWT nell'header Authorization.

  • Authorization: Bearer <JWT_TOKEN>. Il pdnd-connector effettua una validazione del token. Per le API di configurazione (non direttamente usate da OpenCity per fruizione), è richiesto un admin token. Per le API di fruizione e validazione, è richiesto un user token, e il codice fiscale contenuto nel token viene verificato con quello eventualmente presente nella URL.

Esempi di chiamate API

Di seguito, alcuni esempi di richieste e risposte per chiarire il flusso di integrazione.

Accertamento Residenza

Richiesta:

GET /anpr/accertamento-residenza
Headers:
  Authorization: Bearer <token_jwt>
Query Parameters:
  fiscal_code: RSSMRA80A01H501U
  config_id: a6fcd036-f1a2-4df5-b986-7410e9e0e97a
  format: residenza

Risposta:

{
  "data": {
    "address": "Via Roma",
    "house_number": "123",
    "municipality": "Roma",
    "county": "RM",
    "postal_code": "00100"
  },
  "meta": {
    "signature": "base64_encoded_signature",
    "format": "residenza",
    "created_at": "2024-03-26T10:00:00Z",
    "source": "ANPR",
    "call_url": "https://api.example.com/anpr/accertamento-residenza?config_id=a6fcd036-f1a2-4df5-b986-7410e9e0e97a&fiscal_code=RSSMRA80A01H501U&format=residenza"
  }
}

È disponibile anche il formato "residenza_archetipo" che include campi aggiuntivi:

{
  "data": {
    "address": "Via Roma",
    "house_number": "123",
    "municipality": "Roma",
    "county": "RM",
    "postal_code": "00100",
    "municipality_istat_code": "058091",
    "locator_within": "int1"
  },
  "meta": {
    // ... stessi campi meta ...
  }
}

Stato Famiglia

Richiesta:

GET /anpr/stato-famiglia
Headers:
  Authorization: Bearer <token_jwt>
Query Parameters:
  fiscal_code: RSSMRA80A01H501U
  config_id: c88d7efe-84a1-43c5-9edc-07f18a577289
  format: famiglia

Risposta (esempio con coniuge e figli):

{
  "data": {
    "birth_date": "1980-01-01",
    "birth_place": "Roma",
    "family_name": "Rossi",
    "given_name": "Maria",
    "gender": "femmina",
    "tax_id": "RSSMRA80A41H501U",
    "children": [
      {
        "birth_date": "2010-02-25",
        "birth_place": "Roma",
        "family_name": "Rossi",
        "given_name": "Marco",
        "gender": "maschio",
        "tax_id": "RSSMRC10B25H501U"
      },
      {
        "birth_date": "2012-03-15",
        "birth_place": "Roma",
        "family_name": "Rossi",
        "given_name": "Laura",
        "gender": "femmina",
        "tax_id": "RSSLRA12C55H501U"
      }
    ]
  },
  "meta": {
    "signature": "base64_encoded_signature",
    "format": "famiglia",
    "created_at": "2024-03-26T10:00:00Z",
    "source": "ANPR",
    "call_url": "https://api.example.com/anpr/stato-famiglia?config_id=c88d7efe-84a1-43c5-9edc-07f18a577289&fiscal_code=RSSMRA80A01H501U&format=famiglia"
  }
}

Validazione delle risposte

Per validare l'autenticità di una risposta, si utilizza il relativo l'endpoint di validazione:

Richiesta:

POST /validate
Headers:
  Authorization: Bearer <token_jwt>
Query Parameters:
  fiscal_code: RSSMRA80A01H501U
  config_id: a6fcd036-f1a2-4df5-b986-7410e9e0e97a
  format: residenza
Body:
{
  "data": {
    // ... dati ricevuti ...
  },
  "meta": {
    // ... meta ricevuti con la firma ...
  }
}

Risposta:

{
  "result": true  // o false se la validazione fallisce
}

Definizione OpenAPI

Accertamento Cittadinanza

get

fruizione e-service Accertamento Cittadinanza

Query parameters

fiscal_codestringOptional

italian fiscal code

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

config_idstringOptional

id that identify a specific configuration to call an e-service

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

formatstringOptional

identify the output payload structure

Header parameters

AuthorizationstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Responses

200

OK

application/json

404

Not Found

application/json

get

/anpr/accertamento-cittadinanza

HTTPcURLJavaScriptPython

GET /anpr/accertamento-cittadinanza HTTP/1.1
Accept: */*

{
  "data": {
    "cittadinanza": [
      {
        "istat_code": "text",
        "nationality": "text"
      }
    ]
  },
  "meta": {
    "call_url": "text",
    "config_id": "text",
    "created_at": "text",
    "fiscal_code": "text",
    "format": "text",
    "signature": "text",
    "source": "text",
    "validation_url": "text"
  }
}

Accertamento Generalità

get

fruizione e-service Accertamento Generalità

Query parameters

fiscal_codestringOptional

italian fiscal code

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

config_idstringOptional

id that identify a specific configuration to call an e-service

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

formatstringOptional

identify the output payload structure

Header parameters

AuthorizationstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Responses

200

OK

application/json

404

Not Found

application/json

get

/anpr/accertamento-generalita

HTTPcURLJavaScriptPython

GET /anpr/accertamento-generalita HTTP/1.1
Accept: */*

{
  "data": {
    "idOperazioneANPR": "text",
    "listaAnomalie": [
      {
        "codiceErroreAnomalia": "text",
        "testoErroreAnomalia": "text",
        "tipoErroreAnomalia": "text"
      }
    ],
    "listaSoggetti": {
      "datiSoggetto": [
        {
          "generalita": {
            "codiceFiscale": {
              "codFiscale": "text",
              "validitaCF": "text"
            },
            "cognome": "text",
            "dataNascita": "text",
            "idSchedaSoggettoANPR": "text",
            "luogoNascita": {
              "comune": {
                "codiceIstat": "text",
                "nomeComune": "text",
                "siglaProvinciaIstat": "text"
              },
              "localita": {
                "codiceStato": "text",
                "descrizioneLocalita": "text",
                "descrizioneStato": "text"
              }
            },
            "nome": "text",
            "sesso": "text",
            "soggettoAIRE": "text"
          },
          "identificativi": {
            "idANPR": "text"
          },
          "statoCivile": {
            "statoCivile": "text",
            "statoCivileND": "text"
          }
        }
      ]
    }
  },
  "meta": {
    "call_url": "text",
    "config_id": "text",
    "created_at": "text",
    "fiscal_code": "text",
    "format": "text",
    "signature": "text",
    "source": "text",
    "validation_url": "text"
  }
}

Accertamento Residenza

get

fruizione e-service Accertamento Residenza

Query parameters

fiscal_codestringOptional

italian fiscal code

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

config_idstringOptional

id that identify a specific configuration to call an e-service

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

formatstringOptional

identify the output payload structure

Header parameters

AuthorizationstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Responses

200

OK

application/json

404

Not Found

application/json

get

/anpr/accertamento-residenza

HTTPcURLJavaScriptPython

GET /anpr/accertamento-residenza HTTP/1.1
Accept: */*

{
  "data": {
    "address": "text",
    "address_data": {
      "cap": "text",
      "codice_comune": 1,
      "comune": "text",
      "luogo_istat": "text",
      "pr": "text"
    },
    "codice_istat_comune": "text",
    "country": "text",
    "county": "text",
    "house_number": "text",
    "municipality": "text",
    "postal_code": "text"
  },
  "meta": {
    "call_url": "text",
    "config_id": "text",
    "created_at": "text",
    "fiscal_code": "text",
    "format": "text",
    "signature": "text",
    "source": "text",
    "validation_url": "text"
  }
}

Stato Famiglia

get

Retrieve Stato Famiglia for a specific fiscal code with specific configuration

Query parameters

fiscal_codestringOptional

italian fiscal code

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

config_idstringOptional

id that identify a specific configuration to call an e-service

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

formatstringOptional

identify the output payload structure

Header parameters

AuthorizationstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Responses

200

OK

application/json

404

Not Found

application/json

get

/anpr/stato-famiglia

HTTPcURLJavaScriptPython

GET /anpr/stato-famiglia HTTP/1.1
Accept: */*

{
  "data": {
    "children": [
      {
        "birth_date": "text",
        "birth_place": "text",
        "family_name": "text",
        "gender": "text",
        "given_name": "text",
        "tax_id": "text"
      }
    ]
  },
  "meta": {
    "call_url": "text",
    "config_id": "text",
    "created_at": "text",
    "fiscal_code": "text",
    "format": "text",
    "signature": "text",
    "source": "text",
    "validation_url": "text"
  }
}

ISEE

get

fruizione e-service attestazione ISEE

Query parameters

fiscal_codestringOptional

italian fiscal code

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

config_idstringOptional

id that identify a specific configuration to call an e-service

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

formatstringOptional

ISEE format to fetch

Example: ordinario

Header parameters

AuthorizationstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Responses

200

OK

application/json

404

Not Found

application/json

get

/inps/consultazione-attestazione-residenti-isee

HTTPcURLJavaScriptPython

GET /inps/consultazione-attestazione-residenti-isee HTTP/1.1
Accept: */*

{
  "data": {
    "current": true,
    "dsu_protocol_number": "text",
    "household": [
      {
        "fiscal_code": "text",
        "name": "text",
        "relationship_with_declarant": "text",
        "surname": "text"
      }
    ],
    "isee": 1,
    "submission_date": "text",
    "valid_until": "text"
  },
  "meta": {
    "call_url": "text",
    "config_id": "text",
    "created_at": "text",
    "fiscal_code": "text",
    "format": "text",
    "signature": "text",
    "source": "text",
    "validation_url": "text"
  }
}

Consultazione Indicatore Nucleo ICEF

get

Fruizione e-service Consultazione Indicatore Nucleo ICEF via PDND

Query parameters

fiscal_codestringOptional

codice fiscale italiano

Example: RSSMRA85M05H501B

reference_yearinteger · nullableOptional

anno di riferimento per il calcolo (opzionale, default: anno corrente - 2)

Example: 2023

config_idstringOptional

ID della configurazione e-service

Example: 550e8400-e29b-41d4-a716-446655440000

formatstringOptional

formato della risposta

Example: ordinario

Header parameters

AuthorizationstringOptional

JWT token di autenticazione

Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Responses

200

OK

application/json

400

Bad Request

application/json

404

Not Found

application/json

get

/pat/consultazione-indicatore-nucleo-icef

HTTPcURLJavaScriptPython

GET /pat/consultazione-indicatore-nucleo-icef HTTP/1.1
Accept: */*

{
  "data": {
    "household": [
      {
        "birth_date": "12/10/1997",
        "fiscal_code": "RSSMRA85M05H501B",
        "name": "Mario",
        "surname": "Rossi"
      }
    ],
    "icef": 1,
    "icef_protocol_number": "text",
    "reference_year": 1,
    "valid_from": "text",
    "valid_until": "text"
  },
  "meta": {
    "call_url": "text",
    "config_id": "text",
    "created_at": "text",
    "fiscal_code": "text",
    "format": "text",
    "signature": "text",
    "source": "text",
    "validation_url": "text"
  }
}

Get e-services

get

Retrieve the list of e-services available through the service

Query parameters

offsetintegerOptional

the starting point or the index from which the data should be retrieved

Example: 6

limitintegerOptional

The limit parameter specifies the maximum number of items to be returned in a single page or request

sortstringOptional

...

Header parameters

AuthorizationstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Responses

200

OK

application/json

400

Bad Request

application/json

get

/e-services

HTTPcURLJavaScriptPython

GET /e-services HTTP/1.1
Accept: */*

{
  "data": [
    {
      "aud_client_assertion": "text",
      "audience": "text",
      "endpoint": "text",
      "id": "text",
      "name": "text",
      "slug": "text",
      "version": "text"
    }
  ],
  "links": {
    "next": "text",
    "prev": "text",
    "self": "text"
  },
  "meta": {
    "page": {
      "limit": 1,
      "offset": 1,
      "sort": "text"
    },
    "total": 1
  }
}

Status health-check

get

...

Responses

200

OK

application/json

500

Internal Server Error

application/json

get

/status

HTTPcURLJavaScriptPython

GET /status HTTP/1.1
Accept: */*

{
  "checked_at": "2026-02-04T03:32:29.942Z",
  "id": "text",
  "status": "text"
}

Save Tenant Configuration

post

...

Header parameters

AuthorizationstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Body

application/json

idstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

ipa_codestringOptional

...

Example: 123456

namestringOptional

nome del tenant

Example: comune di Bugliano

Responses

201

Created

application/json

400

Bad Request

application/json

post

/tenants

HTTPcURLJavaScriptPython

POST /tenants HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 93

{
  "id": "b212c4b4-db26-4404-8c7c-47dab99dd2e6",
  "ipa_code": "123456",
  "name": "comune di Bugliano"
}

{
  "created_at": "text",
  "id": "text",
  "ipa_code": "text",
  "name": "text",
  "updated_at": "text"
}

Get Tenant Configuration

get

...

Path parameters

tenant_idstringRequired

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Header parameters

AuthorizationstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Responses

200

OK

application/json

400

Bad Request

application/json

get

/tenants/{tenant_id}

HTTPcURLJavaScriptPython

GET /tenants/{tenant_id} HTTP/1.1
Accept: */*

{
  "created_at": "text",
  "id": "text",
  "ipa_code": "text",
  "name": "text",
  "updated_at": "text"
}

Update tenant Configuration

put

...

Path parameters

tenant_idstringRequired

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Header parameters

AuthorizationstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Body

application/json

ipa_codestringOptional

...

Example: 123456

namestringOptional

nome del tenant

Example: comune di Bugliano

Responses

200

OK

application/json

400

Bad Request

application/json

put

/tenants/{tenant_id}

HTTPcURLJavaScriptPython

PUT /tenants/{tenant_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "ipa_code": "123456",
  "name": "comune di Bugliano"
}

{
  "created_at": "text",
  "id": "text",
  "ipa_code": "text",
  "name": "text",
  "updated_at": "text"
}

delete Tenants Configuration

delete

...

Path parameters

tenant_idstringRequired

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Header parameters

AuthorizationstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Responses

204

No Content

application/json

400

Bad Request

application/json

delete

/tenants/{tenant_id}

HTTPcURLJavaScriptPython

DELETE /tenants/{tenant_id} HTTP/1.1
Accept: */*

{
  "created_at": "text",
  "id": "text",
  "ipa_code": "text",
  "name": "text",
  "updated_at": "text"
}

Update tenant Configuration

patch

...

Path parameters

tenant_idstringRequired

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Header parameters

AuthorizationstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Body

application/json

ipa_codestringOptional

...

Example: 123456

namestringOptional

nome del tenant

Example: comune di Bugliano

Responses

200

OK

application/json

400

Bad Request

application/json

patch

/tenants/{tenant_id}

HTTPcURLJavaScriptPython

PATCH /tenants/{tenant_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "ipa_code": "123456",
  "name": "comune di Bugliano"
}

{
  "created_at": "text",
  "id": "text",
  "ipa_code": "text",
  "name": "text",
  "updated_at": "text"
}

Get Clients list

get

Get Clients Configuration list for specific tenant

Path parameters

tenant_idstringRequired

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Query parameters

limitintegerOptional

The limit parameter specifies the maximum number of items to be returned in a single page or request

sortstringOptional

...

offsetintegerOptional

the starting point or the index from which the data should be retrieved

Example: 6

Header parameters

AuthorizationstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Responses

200

OK

application/json

400

Bad Request

application/json

get

/tenants/{tenant_id}/clients

HTTPcURLJavaScriptPython

GET /tenants/{tenant_id}/clients HTTP/1.1
Accept: */*

{
  "data": [
    {
      "created_at": "text",
      "env": "text",
      "id": "text",
      "key_id": "text",
      "key_pair_id": "text",
      "name": "text",
      "public_key": "text",
      "tenant_id": "text",
      "updated_at": "text"
    }
  ],
  "links": {
    "next": "text",
    "prev": "text",
    "self": "text"
  },
  "meta": {
    "page": {
      "limit": 1,
      "offset": 1,
      "sort": "text"
    },
    "total": 1
  }
}

store client pdnd Configuration

post

Save client pdnd Configuration of specific tenant

Path parameters

tenant_idstringRequired

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Header parameters

AuthorizationstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Body

application/json

envstringOptional

ambiente del client

Example: collaudo

idstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

key_idstringOptional

key id del client

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

key_pair_idstringOptional

id interno del materiale critografico

namestringOptional

nome del tenant

Example: comune di Bugliano

Responses

201

Created

application/json

400

Bad Request

application/json

403

Forbidden

application/json

post

/tenants/{tenant_id}/clients

HTTPcURLJavaScriptPython

POST /tenants/{tenant_id}/clients HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 159

{
  "env": "collaudo",
  "id": "b212c4b4-db26-4404-8c7c-47dab99dd2e6",
  "key_id": "b212c4b4-db26-4404-8c7c-47dab99dd2e6",
  "key_pair_id": "text",
  "name": "comune di Bugliano"
}

{
  "created_at": "text",
  "env": "text",
  "id": "text",
  "key_id": "text",
  "key_pair_id": "text",
  "name": "text",
  "public_key": "text",
  "tenant_id": "text",
  "updated_at": "text"
}

Get client pdnd Configuration

get

Get client pdnd Configuration of specific tenant

Path parameters

client_idstringRequired

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

tenant_idstringRequired

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Header parameters

AuthorizationstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Responses

200

OK

application/json

400

Bad Request

application/json

403

Forbidden

application/json

get

/tenants/{tenant_id}/clients/{client_id}

HTTPcURLJavaScriptPython

GET /tenants/{tenant_id}/clients/{client_id} HTTP/1.1
Accept: */*

{
  "created_at": "text",
  "env": "text",
  "id": "text",
  "key_id": "text",
  "key_pair_id": "text",
  "name": "text",
  "public_key": "text",
  "tenant_id": "text",
  "updated_at": "text"
}

Update client pdnd Configuration

put

Update client pdnd Configuration of specific tenant

Path parameters

tenant_idstringRequired

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

client_idstringRequired

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Header parameters

AuthorizationstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Body

application/json

envstringOptional

ambiente del client

Example: collaudo

key_idstringOptional

key id del client

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

key_pair_idstringOptional

id interno del materiale critografico

namestringOptional

nome del tenant

Example: comune di Bugliano

Responses

200

OK

application/json

400

Bad Request

application/json

403

Forbidden

application/json

put

/tenants/{tenant_id}/clients/{client_id}

HTTPcURLJavaScriptPython

PUT /tenants/{tenant_id}/clients/{client_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 115

{
  "env": "collaudo",
  "key_id": "b212c4b4-db26-4404-8c7c-47dab99dd2e6",
  "key_pair_id": "text",
  "name": "comune di Bugliano"
}

{
  "created_at": "text",
  "env": "text",
  "id": "text",
  "key_id": "text",
  "key_pair_id": "text",
  "name": "text",
  "public_key": "text",
  "tenant_id": "text",
  "updated_at": "text"
}

Delete client pdnd Configuration

delete

Delete client pdnd Configuration of specific tenant

Path parameters

client_idstringRequired

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

tenant_idstringRequired

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Header parameters

AuthorizationstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Responses

204

No Content

400

Bad Request

application/json

403

Forbidden

application/json

delete

/tenants/{tenant_id}/clients/{client_id}

HTTPcURLJavaScriptPython

DELETE /tenants/{tenant_id}/clients/{client_id} HTTP/1.1
Accept: */*

No content

Update client pdnd Configuration

patch

Update client pdnd Configuration of specific tenant

Path parameters

tenant_idstringRequired

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

client_idstringRequired

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Header parameters

AuthorizationstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Body

application/json

envstringOptional

ambiente del client

Example: collaudo

key_idstringOptional

key id del client

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

key_pair_idstringOptional

id interno del materiale critografico

namestringOptional

nome del tenant

Example: comune di Bugliano

Responses

200

OK

application/json

400

Bad Request

application/json

403

Forbidden

application/json

patch

/tenants/{tenant_id}/clients/{client_id}

HTTPcURLJavaScriptPython

PATCH /tenants/{tenant_id}/clients/{client_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 115

{
  "env": "collaudo",
  "key_id": "b212c4b4-db26-4404-8c7c-47dab99dd2e6",
  "key_pair_id": "text",
  "name": "comune di Bugliano"
}

{
  "created_at": "text",
  "env": "text",
  "id": "text",
  "key_id": "text",
  "key_pair_id": "text",
  "name": "text",
  "public_key": "text",
  "tenant_id": "text",
  "updated_at": "text"
}

Get Config list of specific tenant filtered by client

get

...

Path parameters

tenant_idstringRequired

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

client_idstringRequired

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Query parameters

limitintegerOptional

The limit parameter specifies the maximum number of items to be returned in a single page or request

sortstringOptional

...

offsetintegerOptional

the starting point or the index from which the data should be retrieved

Example: 6

Header parameters

AuthorizationstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Responses

200

OK

application/json

400

Bad Request

application/json

get

/tenants/{tenant_id}/clients/{client_id}/configs

HTTPcURLJavaScriptPython

GET /tenants/{tenant_id}/clients/{client_id}/configs HTTP/1.1
Accept: */*

{
  "data": [
    {
      "call_url": "text",
      "client_id": "text",
      "created_at": "text",
      "eservice_id": "text",
      "id": "text",
      "is_active": true,
      "purpose_id": "text",
      "tenant_id": "text",
      "updated_at": "text"
    }
  ],
  "links": {
    "next": "text",
    "prev": "text",
    "self": "text"
  },
  "meta": {
    "page": {
      "limit": 1,
      "offset": 1,
      "sort": "text"
    },
    "total": 1
  }
}

Get Config list of specific tenant

get

...

Path parameters

tenant_idstringRequired

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Query parameters

limitintegerOptional

The limit parameter specifies the maximum number of items to be returned in a single page or request

sortstringOptional

...

offsetintegerOptional

the starting point or the index from which the data should be retrieved

Example: 6

Header parameters

AuthorizationstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Responses

200

OK

application/json

400

Bad Request

application/json

get

/tenants/{tenant_id}/configs

HTTPcURLJavaScriptPython

GET /tenants/{tenant_id}/configs HTTP/1.1
Accept: */*

{
  "data": [
    {
      "call_url": "text",
      "client_id": "text",
      "created_at": "text",
      "eservice_id": "text",
      "id": "text",
      "is_active": true,
      "purpose_id": "text",
      "tenant_id": "text",
      "updated_at": "text"
    }
  ],
  "links": {
    "next": "text",
    "prev": "text",
    "self": "text"
  },
  "meta": {
    "page": {
      "limit": 1,
      "offset": 1,
      "sort": "text"
    },
    "total": 1
  }
}

Save Service Configuration

post

...

Path parameters

tenant_idstringRequired

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Header parameters

AuthorizationstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Body

application/json

client_idstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

eservice_idstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

is_activeboolean · nullableOptional

...

Example: false

purpose_idstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Responses

201

Created

application/json

400

Bad Request

application/json

post

/tenants/{tenant_id}/configs

HTTPcURLJavaScriptPython

POST /tenants/{tenant_id}/configs HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 175

{
  "client_id": "b212c4b4-db26-4404-8c7c-47dab99dd2e6",
  "eservice_id": "b212c4b4-db26-4404-8c7c-47dab99dd2e6",
  "is_active": false,
  "purpose_id": "b212c4b4-db26-4404-8c7c-47dab99dd2e6"
}

{
  "call_url": "text",
  "client_id": "text",
  "created_at": "text",
  "eservice_id": "text",
  "id": "text",
  "is_active": true,
  "purpose_id": "text",
  "tenant_id": "text",
  "updated_at": "text"
}

Get Config

get

Get config of specific tenant by id

Path parameters

config_idstringRequired

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

tenant_idstringRequired

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Header parameters

AuthorizationstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Responses

200

OK

application/json

400

Bad Request

application/json

get

/tenants/{tenant_id}/configs/{config_id}

HTTPcURLJavaScriptPython

GET /tenants/{tenant_id}/configs/{config_id} HTTP/1.1
Accept: */*

{
  "call_url": "text",
  "client_id": "text",
  "created_at": "text",
  "eservice_id": "text",
  "id": "text",
  "is_active": true,
  "purpose_id": "text",
  "tenant_id": "text",
  "updated_at": "text"
}

Update Config

put

Update config of specific tenant

Path parameters

config_idstringRequired

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

tenant_idstringRequired

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Header parameters

AuthorizationstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Body

application/json

client_idstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

eservice_idstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

is_activeboolean · nullableOptional

...

Example: false

purpose_idstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Responses

200

OK

application/json

400

Bad Request

application/json

put

/tenants/{tenant_id}/configs/{config_id}

HTTPcURLJavaScriptPython

PUT /tenants/{tenant_id}/configs/{config_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 175

{
  "client_id": "b212c4b4-db26-4404-8c7c-47dab99dd2e6",
  "eservice_id": "b212c4b4-db26-4404-8c7c-47dab99dd2e6",
  "is_active": false,
  "purpose_id": "b212c4b4-db26-4404-8c7c-47dab99dd2e6"
}

{
  "call_url": "text",
  "client_id": "text",
  "created_at": "text",
  "eservice_id": "text",
  "id": "text",
  "is_active": true,
  "purpose_id": "text",
  "tenant_id": "text",
  "updated_at": "text"
}

Disable Config

delete

Soft deleting config of specific tenant

Path parameters

config_idstringRequired

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

tenant_idstringRequired

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Header parameters

AuthorizationstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Responses

204

No Content

400

Bad Request

application/json

delete

/tenants/{tenant_id}/configs/{config_id}

HTTPcURLJavaScriptPython

DELETE /tenants/{tenant_id}/configs/{config_id} HTTP/1.1
Accept: */*

No content

Patch Config

patch

Patch config of specific tenant

Path parameters

config_idstringRequired

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

tenant_idstringRequired

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Header parameters

AuthorizationstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Body

application/json

client_idstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

eservice_idstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

is_activeboolean · nullableOptional

...

Example: false

purpose_idstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Responses

200

OK

application/json

400

Bad Request

application/json

patch

/tenants/{tenant_id}/configs/{config_id}

HTTPcURLJavaScriptPython

PATCH /tenants/{tenant_id}/configs/{config_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 175

{
  "client_id": "b212c4b4-db26-4404-8c7c-47dab99dd2e6",
  "eservice_id": "b212c4b4-db26-4404-8c7c-47dab99dd2e6",
  "is_active": false,
  "purpose_id": "b212c4b4-db26-4404-8c7c-47dab99dd2e6"
}

{
  "call_url": "text",
  "client_id": "text",
  "created_at": "text",
  "eservice_id": "text",
  "id": "text",
  "is_active": true,
  "purpose_id": "text",
  "tenant_id": "text",
  "updated_at": "text"
}

Get Key

get

Get key unused key for a specific tenant

Path parameters

tenant_idstringRequired

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Header parameters

AuthorizationstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Responses

200

OK

application/json

400

Bad Request

application/json

get

/tenants/{tenant_id}/keys

HTTPcURLJavaScriptPython

GET /tenants/{tenant_id}/keys HTTP/1.1
Accept: */*

{
  "id": "text",
  "public_key": "text"
}

Delete Key

delete

Delete key used by specific tenant

Path parameters

keys_idstringRequired

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

tenant_idstringRequired

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Header parameters

AuthorizationstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Responses

204

No Content

400

Bad Request

application/json

delete

/tenants/{tenant_id}/keys/{keys_id}

HTTPcURLJavaScriptPython

DELETE /tenants/{tenant_id}/keys/{keys_id} HTTP/1.1
Accept: */*

No content

Validation

post

Validate pdnd e-service response

Header parameters

AuthorizationstringOptional

...

Example: b212c4b4-db26-4404-8c7c-47dab99dd2e6

Body

application/json

DataanyOptional

data to validate. Can be different depending by the format param

Responses

200

OK

application/json

404

Not Found

application/json

post

/validate

HTTPcURLJavaScriptPython

POST /validate HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 238

{
  "Data": null,
  "Meta": {
    "call_url": "text",
    "config_id": "b212c4b4-db26-4404-8c7c-47dab99dd2e6",
    "created_at": "text",
    "fiscal_code": "b212c4b4-db26-4404-8c7c-47dab99dd2e6",
    "format": "text",
    "signature": "...",
    "source": "text",
    "validation_url": "text"
  }
}

{
  "result": true
}