The Italian version constitutes the only official and legally binding version of the document. The English-language version of this document is provided solely as a courtesy to facilitate consultation by users. In the event of any discrepancies, interpretive differences, or inconsistencies between the Italian-language version and any translated version, the Italian text alone shall prevail and be deemed authoritative.

Remote configuration

This configuration is necessary if you want to use one of the following functions:

For both functions, it is in fact necessary to **provide a**REST web service in compliance with the relative OpenAPI.

An exposed web service is characterized by a configuration identifier, a univocal alphanumeric code, generated by IO, which will correspond primarily to a set of endpoints and their API keys.

You must use the specific key [`manage`](../function/publish-a-service/manage-key.md) to manage the configurations: discover [how to retrieve it](../function/publish-a-service/manage-key.md#recupera-la-chiave-manage)

You can define a configuration, retrieve it later, list the defined configurations, and modify a previously created configuration.

You can also define **more than one configuration**, within the [manage key ](../function/publish-a-service/manage-key.md)in use.

For example, if your Organization uses multiple Technology Partners that each expose a REST web service to serve remote features, a different configuration identifier can be defined for each one of them to be used later to send the messages it is tasked with sending.

To manage the configurations you must use the API described in [crus-remote-configurations.md](../api-and-specifications/api-messages/crus-remote-configurations.md "mention").

To specify the **reference configuration for each remote-content message** you must use, at the time of creation, the mandatory parameter [#configuration_id](../api-and-specifications/api-messages/submit-a-message-passing-the-user-tax-code-in-the-request-body.md#configuration_id "mention").

The exposed service must consist of a variable number of endpoints, depending on what you intend to remotely retrieve for your messages and the type of agreement you have signed with PagoPA:

Endpoint retrieval of:	Data to return to IO	Details
opening preconditions	subject and body of preconditions
message details	message subject and body; attachment metadata (Premium entities only).	the message details must match the intent flags declared when the message is created
attachment bytes	bytes of the individual attachment (Premium entities only)

For details about how to design the endpoints and the relative API shown, refer to [openapi-recovery-endpoint-of-remote-content.md](../api-and-specifications/openapi-recovery-endpoint-of-remote-content.md "mention").

Once ready, use the API described in CRUs, remote configurations to register the necessary data with the IO systems, including:

the base URL that IO will use to dial the addresses of the endpoints exposed by your Organization (for more information refer to the examples given in OpenAPI recovery endpoint of remote content
the** API key** that IO will use to authenticate to your systems and its expected header
the default preference, if any, related to preconditions to opening messages (for more information on preconditions refer to Send a message with remote content)

In order to ensure consistency and proper in-app operation of remote-content messages over time **it is not possible to delete a configuration** once defined.

In addition, for the same reason, it is the sender's responsibility to promptly adjust the configurations whenever necessary, using the management API described in CRUs, remote configurations.

Haven't completed onboarding yet and need help?

Write an email describing your problem or question to the address areariservata@assistenza.pagopa.it.

Need help with APIs and Integration?

Write an email describing your problem or question to the address:

io-service-management@pagopa.it

Tell us what you think

To report problems or give feedback, leave a comment in the GitHub space of the IO app

IO, the public services app

Table of contents

Remote configuration

Haven't completed onboarding yet and need help?

Need help with APIs and Integration?

Tell us what you think