LogoLogo
v1.3
v1.3
  • 🏠Per iniziare
  • 🕗Changelog
  • 🔢Setup iniziale
  • Funzionalità
    • 📦Creare un servizio
      • Dati obbligatori
        • Attributi
        • Service Metadata
      • Controllo di qualità
      • Come visualizzare un servizio in test
    • ✉️Inviare un messaggio
      • Controllo pre-invio
      • Invio messaggio
      • Controllo post-invio
      • Invio messaggi di test
  • 📐API
    • OpenAPI
    • API Messaggi
      • Get a User Profile using POST
      • Submit a Message passing the user fiscal_code in the request body
      • Get Message
      • Get Subscriptions Feed
      • ⚠️Get a User Profile
      • ⚠️Submit a Message passing the user fiscal_code as path parameter
    • API Servizi
      • Create Service
      • Get User Services
      • Get Service
      • Update Service
      • Regenerate Service Key
      • Upload service logo
      • Upload organization logo
    • Errori comuni
    • Specifiche API
  • 🔑Abilitazioni
    • Test con codici fiscali reali
    • Test invio avvisi pagoPA
    • Invio messaggi massivo
    • Subscription feed
    • Gestione dei servizi
  • Risorse Utili
    • ❓Domande frequenti
    • 📘Glossario
Powered by GitBook
On this page
  • service_name
  • organization_name
  • organization_fiscal_code
  • department_name
  • authorized_cidrs
  • is_visible
  • max_allowed_payment_amount
  • version
  • require_secure_channels
  • service_id
  • id
  • authorized_recipients
  • primary_key
  • secondary_key
  1. Funzionalità
  2. Creare un servizio
  3. Dati obbligatori

Attributi

service_name

Descrizione

Nome del servizio visualizzato in app

Tipo

Stringa

Obbligatorio

Sì

"Carta d'Identità Elettronica"

"TARI"

organization_name

Descrizione

Nome ente che eroga il servizio

Tipo

Stringa

Obbligatorio

Sì

“Comune di Milano”

organization_fiscal_code

Descrizione

Codice fiscale dell’ente che eroga il servizio.

Tipo

Stringa

Obbligatorio

Sì

“00907501001”

department_name

Descrizione

Nome dell‘Unità Operativa dell’ente che eroga il servizio

Tipo

Stringa

Obbligatorio

Sì

“Anagrafe”

authorized_cidrs

Di default non sono applicate restrizioni, è obbligatorio inserire le restrizioni ip prima del passaggio in produzione.

Descrizione

Lista ip/subnet autorizzate per richiamare il servizio.

Tipo

Lista di stringhe

Obbligatorio

Sì

1.2.3.4/32;2.3.4.5/32

is_visible

In fase di test, è importante impostare il valore a false.

Descrizione

Flag che modifica la visibilità del servizio in app.

Tipo

Booleano

Obbligatorio

Sì

false

max_allowed_payment_amount

Descrizione

Importo massimo autorizzato nei messaggi associati ad un avviso di pagamento pagoPA. L’importo è inteso in centesimi di euro, cioè come parte intera più due cifre decimali. Ad esempio per impostare una soglia di pagamento di 1500,00 € inserire il valore 150000.

Tipo

Intero

Obbligatorio

Sì, se il servizio prevede l’invio di avvisi di pagamento pagoPA.

1000000

version

Il versionamento è automaticamente gestito dall’infrastruttura di IO e non è necessario inviare questo campo.

Descrizione

Numero di versione del servizio.

Tipo

No

Obbligatorio

Intero

1

require_secure_channels

Descrizione

Flag che permette di anonimizzare le notifiche inviate agli utenti (push e email). Il valore predefinito è false.

Se true, il contenuto è generico: "Hai un nuovo messaggio"

Se true, non viene inviata alcuna email, a prescindere dalle preferenze dell'utente.

Tipo

Booleano

Obbligatorio

No

false

service_id

Questa proprietà non è modificabile ed è considerata in sola lettura.

Descrizione

Identificativo del servizio. È il riferimento da usare come parametro nel path della richiesta per invocare i servizi come Update Service e Upload Service Logo.

Tipo

Stringa

“01EXPKTF05Z2AWEN0PN99QZE79”

id

Questa proprietà non è modificabile ed è considerata in sola lettura.

Questa proprietà non va inviata nelle request e sarà aggiornata in automatico ad ogni modifica del servizio.

Descrizione

Identificativo versionato del servizio: è la composizione di "service_id"+"version" con zero fill.

Tipo

Stringa

“01EXPKTF05Z2AWEN0PN99QZE79-0000000000000001”

authorized_recipients

Alla creazione di un servizio è possibile inviare messaggi soltanto al cittadino di test con codice fiscale AAAAAA00A00A000A. Se l’utente è abilitato all’invio a qualsiasi codice fiscale questa restrizione non si applica.

Descrizione

Lista dei codici fiscali a cui il servizio può inviare messaggi.

Tipo

Lista di stringhe

Obbligatorio

No

“AAAAAA00A00A000A”

primary_key

Descrizione

Chiave primaria del servizio da inviare nell’header Ocp-Apim-Subscription-Key. Tramite l’api XXXX sarà generata una nuova chiave primaria. Chiave primaria e secondaria sono equivalenti e sono duplicate per poter effettuare il cambio delle chiavi senza interruzione del servizio.

Tipo

stringa

Obbligatorio

n.a.

”__YOUR_API_KEY__”

secondary_key

Descrizione

Chiave secondaria del servizio da inviare in alternativa alla chiave primaria nell’header Ocp-Apim-Subscription-Key. Tramite l’api XXXX sarà generata una nuova chiave secondaria. Chiave primaria e secondaria sono equivalenti e sono duplicate per poter effettuare il cambio delle chiavi senza interruzione del servizio.

Tipo

stringa

Obbligatorio

__YOUR_API_KEY__”

PreviousDati obbligatoriNextService Metadata

Last updated 2 years ago

Notifica Push

Email

📦
🔔
✉️