The FDK enables you to define and use parameters whose values app users can set when they install an app. These parameters are termed installation parameters or iparams. To define and use iparams:

1. Configure the iparams. During app installation, the configured iparams are displayed on an installation page. App users can enter appropriate values for the iparams and click INSTALL. The entered values are validated and saved.
2. In the app logic, use the client.iparams.get(), client.iparams.get(iparam_key), or the Request method (for secure iparams), to retrieve the iparam values.

   Note

   To prevent exposure of sensitive iparam information, secure iparams can only be retrieved by the Request method.

For serverless apps, the configured iparams are passed as part of event payloads. The app logic can retrieve the iparams' values from the payload.