• Documentation
  • API Custom Verification

API Custom Verification


Other than the usual authentication methods, APIM offers another authentication option when invoking third-party APIs where third-party API providers can create their own custom verification methods by customizing the Lua script and bind created APIs to them in EnOS. This enables the third-party API providers to call the verification service provided by third-party and return the verification result when invoking the said APIs.


APIM uses the authentication functions in the custom verification configuration script to connect to the back-end authentication system, obtain the access authorization of the back-end service, and return the the verification result.


This section shows how to create a custom verification.

Before You Start

  • Ensure that you have an EnOS account and the permissions to create APIs in the EnOS Management Console. For more information, see Policies, Roles, and Permissions.

  • Ensure that you have completed the Deploying APIs task as third-party APIs can be invoked by a third-party only after being released and set as public in EnOS.

Procedure

  1. Log in to the EnOS Management Console and select API Management > Custom Verification.

  2. Click the Create Custom Verification button, fill in the required information, and click Save.

    ../_images/custom_verification.png


  3. You can edit the details of the custom verification such as its name, script, and description, and edit/create new/delete its custom variables by clicking its Edit icon.

  4. There are two ways where you can bind APIs to a custom verification. The first is by clicking its View icon to enter its details page, and click the Bind API button. The second is by clicking its Bind API icon. Search for an API via its group or API name, select it, and click Save.

    Note

    A custom verification can bind multiple APIs but each API can be bound to only one custom verification.