Welcome to Zuora Product Documentation

Explore our rich library of product information

Configure SDK features in developer interface

Learn how to configure and implement SDK features using the Developer Interface, including setting identifiers, configuring inputs and outputs, and obtaining implementation code.

The Developer Interface for SDK Features lets you define how an SDK-based feature is configured and implemented. Use this interface to set identifiers, configure inputs and outputs, and copy implementation code for your integration.

To define the Developer Interface for an SDK feature, complete the following steps:

  1. Enter or update the slug in the Slug text box. The slug is a unique identifier used to reference this feature in your code. Choose a clear, descriptive value to avoid conflicts.
  2. Define the information to provide to Zephr by enabling or disabling Inputs . By default, the following inputs are enabled:
    • Session (required for Registered and Customer journeys)

    • IP Address

    • User Agent

    • Path

    • Content ID

    You can toggle inputs on or off as needed.
  3. Define any Custom Inputs used to provide information to Zephr. To define custom inputs:
    1. Click Add Input . The Add Input dialog box is displayed.
    2. Enter a name for the custom input in the Title text box.
    3. Enter the identifier used for the input in the Key text box.
    4. Select the type of input from the Type drop-down options. The options are as follows:
      • String

      • Number

      • Boolean

    5. Click Add to add the custom input and return to the SDK Outputs screen. Selecting the Cancel button displays the SDK Outputs screen without adding a custom input.
  4. Define the output to use in your feature rule from the Type drop-down menu. The options are as follows: topic.
    • Component

    • Enum

    • String

    • Number

    For further information on these output types, see the Output Types.
  5. Follow the instructions below to configure for different output types:
    • If you select Component or Enum from the Type drop-down menu, select the Add Option button.
      • If you select Component, the Add Option dialog is displayed. To define the component output, complete the following steps:
        1. Enter a name for the output in the Title text box.

        2. Enter the HTML code to render in the outcome in the Value text box.

        3. Click Add to save the output and return to the SDK Outputs screen. Selecting the Cancel button displays the SDK Outputs screen without saving the output.

      • If you select Enum, the Add Option dialog is displayed.
        1. Enter a name for the output in the Title text box.

        2. Enter the enum data to render in the outcome in the Value text box.

          Click Add to save the output and return to the SDK Outputs screen. Selecting the Cancel button displays the SDK Outputs screen without saving the output.

    • If you select JSON, you can provide a JSON schema after turning on the Validate with JSON Schema option, as illustrated below: Later in the Rules Builder canvas, you can create JSON output options using a form that is dynamically generated from the JSON schema specified. The output options are validated to ensure they are valid JSON and that they conform to the schema if specified.

    • To use Zephr's out-of-box forms in your SDK rules, select Transformation . You can then add outcomes and customized forms to your SDK feature. For more information about how to add outcomes and how to work with forms, see the Feature Outcomes documentation. Note that when creating an outcome, you can either hide or show all content. Truncating content is not supported.

  6. Obtain the implementation code, which can be used to flag the feature in your code To obtain the implementation code, complete the following steps:
    1. Select the language in which you want the code from the Select Language drop-down menu. The options are as follows:
      • cURL

      • Browser

      • Node JS

      • Java

    2. If you select Browser , Node JS , or Java from the Select Language drop-down menu options, install the relevant SDK if not already installed The command to install the relevant SDK is displayed beneath the drop-down menu. For further information on the SDKs and their installation, see the Zephr SDK section.
    3. Select Copy , which displays in the top-right of the code box when you hover over the Usage code sample The code is copied to your clipboard.
  7. Select Update & Lock . Then choose Save to store the SDK Feature. Or, use Save & Publish to make the feature immediately available for use.
    You can build your rule using the output in the Rules Builder. For further information on the available decision nodes, see the Feature Decision Nodes topic.