Nexmo Environment App

As a preliminary step to adding Nexmo Verify 2FA service to your mobile app using Appdome, Nexmo and Appdome customers are encouraged to verify their backend servers are configured correctly to work with the Nexmo Verify MFA service.

To make it easy to tell if your servers are configured correctly, Appdome has created a simple Nexmo Environment app.
Upon standard login to the backend servers, the app will diagnose the HTTP response and indicate if it holds the required parameters needed to trigger the Nexmo
Verify MFA.

This Knowledge Base article describes how you can use the app and verify your servers compliance to Nexmo service.

Prerequisites to Using Nexmo Environment App 

In order to use the Nexmo Environment app, you’ll need:

  • The Nexmo Environment App  (available upon request from the Nexmo/Appdome support team)
  • A configured and accessible backend server
  • URL which initiates the customer app login sequence
  • Login credentials for your backend server
  • Phone number (Which will be returned by the server backend after a successful login sequence)
  • An iOS device

How to Use the Nexmo Environment App

When using the Nexmo Environment App, you will be required to Customize Login Detect and choose the method by which to detect the login and extract the phone number.
There are two options to detect if your backend server HTTP response holds the required parameters needed to trigger the Nexmo Verify MFA service:

Detect by Header: The HTTP response header name will contain a key whose value is the entered phone number.
Detect by JSON Body: The HTTP response payload will contain a JSON key whose value is the entered phone number.

Using the “Detect by Header” method

After receiving the Nexmo Environment App from Nexmo/Appdome support, you’ll need to install it on your device. You can use iMazing or Xcode to install the app.

Once you have the app ready, follow these steps:

  1. Enter the URL which initiates the customer app login sequence
  2. Choose the login detection method  –  Detect by Header
  3. Enter the Header key (the default header is X-PhoneNumber)
  4. Enter the phone number which will be returned by the server backend after a successful login
  5. Click Check Login Detect to start the login sequence
  6. Login to your backend server by entering the login credentials
  7. For more information on “Phone Number isn’t Detected”, see Unsuccessful Login Detection

Using the “Detect by JSON Body” method

After receiving the Nexmo Environment App from Nexmo/Appdome support, you’ll need to install it on your device. You can use iMazing or Xcode to install the app.

Once you have the app ready, follow these steps:

  1. Enter the URL which initiates the customer app login sequence
  2. Choose the login detection method  –  Detect by JSON Body
  3. Enter the JSON key (the default key is phone)
  4. Enter the phone number which will be returned by the server backend after a successful login
  5. Click Check Login Detect to start the login sequence
  6. Login to your backend server by entering the login credentials
  7. For more information on “Non Json Response”, see Unsuccessful Login Detection

Successful Login Detection

If your server was configured correctly, the app will successfully extract the phone number from the server HTTP response.

You will see a green indication along with “Phone Number is Detected” message at the bottom sheet.

To view the HTTP response holding the phone number swipe up the bottom sheet.
Note! the report may record multiple HTTP responses, depends on the login sequence. Scroll down to view them all.
For example:

Unsuccessful Login Detection

In case the app failed to detect the phone number in the backend server HTTP response, it will present one of the following indications at the bottom sheet:

Phone Number isn’t Detected

Cause: The key and the phone number weren’t detected in the Header/JSON body.

Troubleshooting:

1. Swipe up the bottom sheet to view the HTTP response. The report may record multiple HTTP responses, depends on the login sequence. Scroll down to view them all.

2. Try to locate the phone number in the response. Verify it was entered correctly (with/without spaces and dashes etc.)

3. If you located the correct format for the phone number, identify the matching key.
Go back to the main page and re-enter the correct key and phone number.
Click Check Login Detect to start the login sequence again.

4. If you failed to locate the phone number and the matching key – we recommend contacting Nexmo support to troubleshoot the backend server configuration.

Sending the app report/logs to Appdome support:
At any point, you can send Appdome the app logs by email. Click on the Share icon   to launch the device email client with the logs attached.
An email window will pop-up with the log attached. The email will be sent directly to Appdome support team.

Wrong Phone Detected

Cause: The phone number wasn’t detected in the Header/JSON body as the matching value to the entered key.

Troubleshooting:

1. Swipe up the bottom sheet to view the HTTP response. The report may record multiple HTTP responses, depends on the login sequence. Scroll down to view them all.

2. Try to locate the key in the response. Compare the entered phone number to the one received from the server (with/without spaces and dashes etc.)

3. If you located the correct phone number, go back to the main page and re-enter it along with the key.
Click Check Login Detect to start the login sequence again.

4. If you failed to locate the correct phone number – we recommend contacting Nexmo support to troubleshoot the backend server configuration.


Sending the app report/logs to Appdome support:
At any point, you can send Appdome the app logs by email. Click on the Share icon   to launch the device email client with the logs attached.
An email window will pop-up with the log attached. The email will be sent directly to Appdome support team.

Wrong Key Detected

Cause: The key wasn’t detected in the Header/JSON body as the matching key to the entered phone number.

Troubleshooting:

1. Swipe up the bottom sheet to view the HTTP response. The report may record multiple HTTP responses, depends on the login sequence. Scroll down to view them all.

2. Try to locate the phone number in the response. Compare the entered key to the one received from the server (lower/upper case, spaces and dashes etc.)

3. If you located the correct key, go back to the main page and re-enter it along with the phone number.
Click Check Login Detect to start the login sequence again.

4. If you failed to locate the correct key – we recommend contacting Nexmo support to troubleshoot the backend server configuration.


Sending the app report/logs to Appdome support:
At any point, you can send Appdome the app logs by email. Click on the Share icon   to launch the device email client with the logs attached.
An email window will pop-up with the log attached. The email will be sent directly to Appdome support team.

 

Non Json Response

Cause: The HTTP response isn’t in JSON format

Troubleshooting:

1. Swipe up the bottom sheet to view the HTTP response. The report may record multiple HTTP responses, depends on the login sequence. Scroll down to view them all.

2. If the HTTP response header contains the key and the phone number, go back to the main page and change the Login Detect method to “Detect By  Header” and try again.

3. If the HTTP response header doesn’t contain the key and the phone number, we recommend contacting Nexmo support to troubleshoot the backend server configuration.


Sending the app report/logs to Appdome support:
At any point, you can send Appdome the app logs by email. Click on the Share icon   to launch the device email client with the logs attached.
An email window will pop-up with the log attached. The email will be sent directly to Appdome support team.

How Do I Learn More?

If you have any questions, please send them our way at support@appdome.com or via the chat window on the Appdome platform. You can Request a demo at any time

Thank you!

Thanks for visiting Appdome! Our mission is to make mobile integration easy. We hope we’re living up to the mission with your project. If you don’t already have an account, you can sign up for free.  

Liron Dror

Have a question?

Ask an expert