Manage Service: Create

Descrizione

Questa API permette di creare un servizio.

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

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

Create a new service

post

Create a new Service with the attributes provided in the request payload

Authorizations

Body

all ofOptional

A payload used to create or update a service.

and

Responses

201

Service created successfully

application/json

Responseall of

Service Lifecycle model data

and

400

Invalid payload.

application/json

401

Unauthorized

403

Forbidden

429

Too many requests

500

Internal server error

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/manage/services HTTP/1.1
Host: api.io.pagopa.it
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 503

{
  "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": "text",
  "description": "text",
  "organization": {
    "name": "text",
    "fiscal_code": "12345678901",
    "department_name": "text"
  },
  "require_secure_channel": true,
  "authorized_recipients": [
    "SPNDNL80R13C555X"
  ],
  "authorized_cidrs": [
    "text"
  ],
  "max_allowed_payment_amount": 0
}

{
  "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",
    "department_name": "text"
  },
  "require_secure_channel": true,
  "authorized_recipients": [
    "SPNDNL80R13C555X"
  ],
  "authorized_cidrs": [
    "text"
  ],
  "max_allowed_payment_amount": 0
}

Esempi

Ecco un esempio con le informazioni minime per la creazione di un servizio di test:

### REQUEST
curl --location --request POST 'https://api.io.pagopa.it/api/v1/manage/services' \
--header 'Ocp-Apim-Subscription-Key: __YOUR_API_KEY__' \
--header 'Content-Type: application/json' \
--data-raw '{
  "name": "string",
  "description": "string",
  "organization": {
    "name": "string",
    "fiscal_code": "12345678901",
    "department_name": "string"
  },
  "require_secure_channel": false,
  "authorized_cidrs": [
    "85.338.5.14/32"
  ],
  "metadata": {
    "web_url": "string",
    "app_ios": "string",
    "app_android": "string",
    "tos_url": "string",
    "privacy_url": "string",
    "address": "string",
    "phone": "string",
    "email": "string",
    "pec": "string",
    "cta": "string",
    "token_name": "string",
    "support_url": "string",
    "scope": "LOCAL",
    "topic_id": 3
  }
}'

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

Risorse utili

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