Stable version 1.0.0 (Compatible with OutSystems 11)

Uploaded

on 29 Apr (6 days ago)

0.0

(0 ratings)

Details

The WebOTP API component for OutSystems Forge is a powerful tool designed to enhance user authentication in web applications by seamlessly integrating One-Time Password (OTP) functionality. This component allows developers to easily implement OTP reading capabilities directly within their screens or blocks, streamlining the verification process for users. By leveraging the WebOTP API, this component enables automatic detection and retrieval of OTPs sent via SMS, improving user experience and reducing friction during login or transaction verification. With simple integration, the WebOTP API component is an essential addition for any web application seeking to enhance security and user convenience.

Documentation

About: The WebOTP API component for OutSystems Forge is a powerful tool designed to enhance user authentication in web applications by seamlessly integrating One-Time Password (OTP) functionality. This component allows developers to easily implement OTP reading capabilities directly within their screens or blocks, streamlining the verification process for users. By leveraging the WebOTP API, this component enables automatic detection and retrieval of OTPs sent via SMS, improving user experience and reducing friction during login or transaction verification. With simple integration, the WebOTP API component is an essential addition for any web application seeking to enhance security and user convenience.

How to use:

a) Inputs:

1. TimeoutInSec: Specify the duration in seconds before a timeout event is triggered. If set to zero, no timeout is applied, and the timeout event will not be triggered.

b) Events:

1. OTP: This event returns the OTP when the retrieval is successful.

2. Error: This event triggers if an error occurs while attempting to get the OTP.

3. TimeOut: This event triggers if a timeout occurs before the OTP is received. Note that this event is not triggered if the TimeoutInSec input is set to zero.

4. NotSupported: This event triggers if the browser does not support the WebOTP API.

c) SMS Format for WebOTP API:

The SMS message sent to the user must contain the following mandatory format:

@example.com #123456

In this format:
@example.com represents the domain associated with the OTP request.
#123456 is the actual OTP code sent to the user.

d) Usage Instructions:

1. Integration in Screens or Blocks: Add the OTP block inside an If condition or a container whose visibility is controlled by a boolean variable.

2. Setting the Boolean Variable: When sending the OTP to the user, set the boolean variable to true to display the block.

3. Event Handlers: Add event handlers for the block. Handling the OTP event is mandatory, and it is recommended to handle all events for comprehensive management.

4. Hiding the Block: Once any event is triggered (OTP, Error, TimeOut, NotSupported), set the boolean variable to false to hide the block. Hiding the block is important for performing cleanup tasks.