To generate your email_hash simple examples are shown below (you will need to adjust them to your code).
You will need to use the below secret key to hash a contact's email address:

secret_key

• email_hash: "<?php echo hash_hmac(
              'sha256',
              $user->email,
              'secret_key'
              ); ?>"
  

• email_hash: "<%= OpenSSL::HMAC.hexdigest(
               'sha256',
               'secret_key',
               current_user.email
               ) %>"
  

• email_hash: "{{ hmac.new(
                      'secret_key',
                      request.user.email,
                      digestmod=hashlib.sha256).hexdigest()
                      }}"
  

• import javax.crypto.Mac;
  import javax.crypto.spec.SecretKeySpec;
  
  public class ApiSecurityExample {
      private final static char[] hexArray = "0123456789abcdef".toCharArray();
  
      private static String bytesToHex(byte[] bytes) {
          char[] hexChars = new char[bytes.length * 2];
          for ( int j = 0; j < bytes.length; j++ ) {
              int v = bytes[j] & 0xFF;
              hexChars[j * 2] = hexArray[v >>> 4];
              hexChars[j * 2 + 1] = hexArray[v & 0x0F];
          }
          return new String(hexChars);
      }
  
      public static void main(String[] args) {
          try {
              String key = "secret_key";
              String message = "user@example.com";
  
              Mac sha256_HMAC = Mac.getInstance("HmacSHA256");
              SecretKeySpec secret_key = new SecretKeySpec(key.getBytes(), "HmacSHA256");
              sha256_HMAC.init(secret_key);
  
              String hash = bytesToHex(sha256_HMAC.doFinal(message.getBytes()));
              System.out.println(hash);
          } catch (Exception e) {
              System.out.println("Error");
          }
      }
  }
  

• using System.Security.Cryptography;
  
  public class ApiSecurityExample
  {
      private static string CreateHash(string message, string secret)
      {
          secret = secret ?? "";
          var encoding = new System.Text.ASCIIEncoding();
          byte[] keyByte = encoding.GetBytes(secret);
          byte[] messageBytes = encoding.GetBytes(message);
          using (var hmacsha256 = new HMACSHA256(keyByte))
          {
              byte[] hashmessage = hmacsha256.ComputeHash(messageBytes);
              return System.BitConverter.ToString(hashmessage).Replace("-", string.Empty).ToLower();
          }
      }
  
      public static void Main(string[] args)
      {
          string key = "secret_key";
          string message = "user@example.com";
          System.Console.WriteLine(ApiSecurityExample.CreateHash(message, key));
      }
  }
  

Request a Survey Slug

Survey slugs are used to identify who is receiving the survey and record their responses in a safe and secure manner.

Make a POST request to
POST https://yourdomain.asknice.ly/service/inapp.php?id=uuid

            {
                "domain_key":"yourdomain",
                "template_name":"default",
                "name":"Erwin Schrodinger",
                "email":"schrodinger@example.com",
                "email_hash":"df462ce404bbae11bd4e5860682db02e86ccace29b1a4d631dc7fbe075e321c5",
                "created":"1418350105",
                "force":true,
                "a_custom_property":"Sample String",
            }

Arguments

Response

            {
              "wait": 86400,
              "slug": "abcdefghijkl",
              "show": true,
              "id": 123456,
              "info": ""
            }

Once you have a survey slug, you can display the survey using an iframe, by opening another browser window, or (for mobile applications) loading the URL in a WebView.

Load the url:
GET https://yourdomain.asknice.ly/email/conversation/slug?template_name=template_name&inapp=inapp

For mobile implementations, the page returned implements a message handler under the name askNicelyInterface.
These events return a standard object that consists of a 'event' and 'msg' (message).
The current available events are as follows: