Dokumentasi
Concierge API Request (2 Factor Authentication)
The following sections describe the request URL to Ginota Concierge API and all of its associated input parameters and their corresponding values.
Endpoint URL for subscriber to verify
Call the URL with specified parameters to make subscriber verify with their mobile number. Requests to Ginota must be submitted to following Endpoint URL:
https://www.ginota.com/gemp/otp/discoverMobile
Content Type
Since Ginota Concierge API supports both HTTP GET and HTTP POST method, please specify the input type of application/x-www-form-urlencoded for HTTP POST request. Note that all inputs should be fully URL encoded with Unicode UTF-8 encoding.
Authentication
All requests to Ginota Concierge APIs are authenticated with your Ginota account's API Key and Secret, which you can find under Dashboard > Messaging after login to Ginota Portal.
Input Parameters
The following table lists each parameter that can be submitted together with the Endpoint URL given above. Note that all the 4 parameters are mandatory and case sensitive.
| Parameter | Description | Example Values |
|---|---|---|
| apiKey | Ginota account API Key. | 3zJU%2Ft7DX6g%3D |
| apiSecret | Ginota account API Secret. URL encoded value. | %21ABCDE |
| Subscriber’s valid email address. | jessica@ginota.com | |
| sName | Subscriber’s name text to send to encoded in Unicode UTF-8. Limited to 1500 characters. For binary message, hex-encoded binary data. | Jessica+Anderson |
Steps to verify subscribers
Step 1. Call the URL as above. Email will be sent to subscribers for verification.
Step 2. Subscribers to open the email and click the link provided to verify mobile number.
Step 3. Subscribers to input their mobile number to verify. A text message containing verification code will be sent to subscribers.
Step 4. Subscribers to input the verification code as per received text message.
Step 5. A success message will be displayed to subscriber upon correct input of verification code.
Endpoint URL for subscriber verification
Call the URL with specified parameters for verification of subscribers' mobile number. Requests to Ginota must be submitted to following Endpoint URL:
https://www.ginota.com/gemp/otp/discoverMobileStatus
Content Type
Since Ginota Concierge API supports both HTTP GET and HTTP POST method, please specify the input type of application/x-www-form-urlencoded for HTTP POST request. Note that all inputs should be fully URL encoded with Unicode UTF-8 encoding.
Authentication
All requests to Ginota Concierge APIs are authenticated with your Ginota account's API Key and Secret, which you can find under Dashboard > Messaging after login to Ginota Portal.
Input Parameters
The following table lists each parameter that can be submitted together with the Endpoint URL given above. Note that all the 3 parameters are mandatory and case sensitive.
| Parameter | Description | Example Values |
|---|---|---|
| apiKey | Ginota account API Key. | 3zJU%2Ft7DX6g%3D |
| apiSecret | Ginota account API Secret. URL encoded value. | %21ABCDE |
| userId | Subscriber’s valid email address. | jessica@ginota.com |
Steps for subscribers verification
The following table lists each steps taken verify subscribers.
| Steps Number | Description | Example Output |
|---|---|---|
| 1 | Call the URL as above. Verified subscribers will return discoverStatus as "Confirmed". | {"status":0,"desc":"Ok","mobileNumber":"60123456789","discoverStatus":"Confirmed"} |