Manage Service: Update

Descrizione

Questa API aggiorna le informazioni relative ad un servizio. Per funzionare correttamente richiede l'inserimento del service_id come path parameter.

Devi usare la nuova chiave manage per la gestione dei servizi.

Per utilizzare questa API è necessario richiedere un'abilitazione specifica.

Update service

Update an existing service by ID

put

/manage/services/{serviceId}

Authorizations

Path parameters

serviceIdstringrequired

ID of the service

Body

metadataall ofrequired

A set of service metadata properties on request payload

namestring · min: 1required

descriptionstring · min: 1required

organizationobjectrequired

require_secure_channelboolean

max_allowed_payment_amountinteger · int32 · max: 9999999999

authorized_recipientsstring · FiscalCode[]

authorized_cidrsstring[]

Allowed source IPs or CIDRs for this service. When empty, every IP address it's authorized to call the IO API on behalf of the service.

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.io.pagopa.it/api/v1/manage/services/{serviceId}' \
  --header 'Ocp-Apim-Subscription-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"metadata":{"scope":"LOCAL","topic_id":3},"name":"text","description":"text","organization":{"name":"text","fiscal_code":"12345678901"},"max_allowed_payment_amount":0,"authorized_recipients":["SPNDNL80R13C555X"],"authorized_cidrs":[null]}'

200

400

401

403

404

409

429

500

200

{
  "id": "text",
  "status": {
    "value": "draft",
    "reason": "text"
  },
  "last_update": "2018-10-13T00:00:00.000Z",
  "metadata": {
    "web_url": "text",
    "app_ios": "text",
    "app_android": "text",
    "tos_url": "text",
    "privacy_url": "text",
    "address": "text",
    "phone": "text",
    "email": "text",
    "pec": "text",
    "cta": "text",
    "token_name": "text",
    "support_url": "text",
    "scope": "LOCAL",
    "topic": {
      "id": 3,
      "name": "Benessere sociale"
    }
  },
  "name": "text",
  "description": "text",
  "organization": {
    "name": "text",
    "fiscal_code": "12345678901"
  },
  "require_secure_channel": true,
  "max_allowed_payment_amount": 0,
  "authorized_recipients": [
    "SPNDNL80R13C555X"
  ],
  "authorized_cidrs": [
    "text"
  ]
}

Service updated successfully

Risorse utili

https://developer.io.italia.it/openapi.html#operation/cmsUpdateService