Register the third-party API

Introduction

The third-party API：The Web API from non-DM platform, which may have problems such as cross-domain restrictions when requesting these APIs from DM.

Registration purpose：To solve the cross-domain problem, the platform provides CallAPI interface, which can be forwarded by the platform to the third-party API. To realize the secure forwarding function, developers need to register the third-party API into the DM platform in advance.

API registration description

• Page address：[domain]/[tenant]/[appcode]/admin/thirdpartyapi
• Field description
  • Name：Unique identification of interface, which cannot be modified once it is successfully created.
  • url：Interface address
  • Request Method：The forwarding method, which is only valid for non-vProfile interfaces
  • SecurityToken：Security Check Token, DM forwarding interface sets this value in HTTP header. Header key is：SecurityToken，and header value is the value of SecurityToken.
  • vProfile：Whether or not the interface belongs to vProfile: the vProfile interface only supports post forwarding, so request method is invalid; and the verification of vProfile interface uses other signature methods, so SecurityToken is invalid.
  • Append Userinfo：Whether or not to append the current user information when forwarding the request.
    • User information definition (including plus sign +)：[tenant]+[appCode]+[staffCode]
    • header key：User，UICC
    • UICC：User information check code, which is used to check whether staff code has been falsified.
    • UICC calculation method: please check it in the registration API pop-up window.
  • Description：Interface description, which is only for developers to identify the interface.