Managing APIs

  • Last update:  2023-10-26
  • Managing APIs

    Overview

    You can only be notified by e-mail, SMS, platform, and some clients by the Data Alert plugin of early versions. However, complex alert reception scenarios often exist during actual application, for example, most companies receive notifications through their own OA or dedicated notification platforms. To meet the timeliness of alert notifications and better conform to users' notification-reception habits, the Data Alert plugin opens APIs for you to receive notifications through custom platforms or apps for notifications, improving data alert effectiveness.

    Setting Method

    You need to install the Data Alert plugin and configure relevant permissions first. For details, see Introduction to Data Alert Plugin.

    Where to Set

    Log in to the platform as the super admin, choose System Management > Data Alert, click the setting icon to go to the Third-Party Alert App page, and click Add App to start the configuration.

     

    Setting Page

    Fill in the following configuration items according to the actual situation. For details about these configuration items, see the following table.

     2.png

    Configuration Item

    Mandatory or Not

    Explanation

    App Name

    Yes

    App name to be customized.

    App Description

    No

    App description to be customized.

    App Status

    Yes

    Mandatory configuration item, which can either be Enable (default value) or Disable

    • Enable: If you select Client Notification when creating an alert task, you can select this app as a Push Terminal.

    • Disable: If you select Client Notification when creating an alert task, the app name will not appear when you set Push Terminal.

    Request Address URL

    Yes

    Request URL to be customized.

    Request Method

    Yes

    Mandatory configuration item, which can either be POST (default value) or GET

    Request Header

    Yes

    Key and value to be set.

    Click Add to add key-value pairs in the request header.

    Click the deletion icon to delete the edited key-value pairs (retain at least one pair).

    Some APIs require specific headers to be sent with requests to provide more metadata about the operation being performed. You can set them here by entering any key-value pairs you need.

    Request Body

    No

    Request body to be customized (only in .json, .xml, and .txt formats), which will be sent to the push terminals as the notification body when an alert is triggered. The following parameters are supported:

    • Triggering Time: ${triggeredTime} (in yyyy-MM-dd HH:mm:ss format)

    • Alert Name: ${taskName}

    • Template: ${templatePath}

    • Access Address: ${targetLink} (platform relative address, such as webroot/decision/view/report?viewlet=GettingStarted.cpt)

    • Triggering Condition: ${ruleDescription} (configured condition description)

    • Receiver: ${receiveUsers} (whose character strings are concatenated with half-width commas (,))

    • Number of Data Records Meeting Conditions: ${ruleMatchDataCount}

    • Maximum Value Meeting Conditions: ${ruleMatchDataMax}

    • Minimum Value Meeting Conditions: ${ruleMatchDataMin}

    iconNote:

    If the ${notifyContent} parameter is added in Request Body, the actual content received in the app after the alert task is created is the content of Request Body filled on the app page plus the notification content on the alert creation page.

    If the ${notifyContent} parameter is not added, the actual content received in the app is the content of Request Body filled on the app page.


    Setting Alerts

    After saving the configuration, users with the Data Alert permission can select API Notification under Alert Notification > Notification Method and select the corresponding apps.

     3.png

    Demonstration

    After alert tasks are created, the actual content received in the app after the alert task is created is the content of Request Body filled on the app page plus the notification content on the alert creation page.

    The super admin enters necessary notification content in Request Body on the app configuration page and users customize the notification content in Alert Notification, making the content more flexible.

    4.png

    附件列表


    主题: Creating a Dashboard
    • Helpful
    • Not helpful
    • Only read

    滑鼠選中內容,快速回饋問題

    滑鼠選中存在疑惑的內容,即可快速回饋問題,我們將會跟進處理。

    不再提示

    10s後關閉

    Get
    Help
    Online Support
    Professional technical support is provided to quickly help you solve problems.
    Online support is available from 9:00-12:00 and 13:30-17:30 on weekdays.
    Page Feedback
    You can provide suggestions and feedback for the current web page.
    Pre-Sales Consultation
    Business Consultation
    Business: international@fanruan.com
    Support: support@fanruan.com
    Page Feedback
    *Problem Type
    Cannot be empty
    Problem Description
    0/1000
    Cannot be empty

    Submitted successfully

    Network busy