Difference between revisions of "API Method PingWithAuth"

From Updox API
Jump to: navigation, search
(→‎Destination Address)
(→‎Destination Address)
Line 22: Line 22:
 
=== Destination Address ===
 
=== Destination Address ===
 
<div style="width:500px;">
 
<div style="width:500px;">
−
   {{Base url api|userUpdate|pingWithAuth}}
+
   {{Base url api|pingWithAuth|pingWithAuth}}
 
</div>
 
</div>
  

Revision as of 16:30, 27 November 2013

Ping the server for a response with full authentication. This method verifies that applicationId and applicationPassword are valid and that there is a valid userId under a valid accountId.

Contents

Fields

There are no input fields for this method.

Code Samples

Language Source Code Examples
C#
Java 


   public static void generateHmacHeaders(HttpURLConnection connection, String applicationId, String applicationPassword, String accountId, String userId) throws Exception{
       final SimpleDateFormat d = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss (z)");
       d.setTimeZone(TimeZone.getTimeZone("GMT"));
       final String timestampString = d.format(new Date());
       final String message = 
          (applicationId == null ? "" : applicationId) + ":" + 
          (applicationPassword == null ? "" : applicationPassword) + ":" + 
          (accountId == null ? "" : accountId) + ":" + 
          (userId == null ? "" : userId) + ":" + 
          timestampString;
       final String auth = "HMAC " + hmacSha1ToBase64(message, apiSecret); //note space after HMAC
       connection.setRequestProperty("updox-timestamp", timestampString);  
       connection.setRequestProperty("Authorization", auth);
   }
   
   public static String hmacSha1ToBase64(String value, String key) throws Exception{
       byte[] keyBytes = key.getBytes();
       SecretKeySpec signingKey = new SecretKeySpec(keyBytes, "HmacSHA1");
       Mac mac = Mac.getInstance("HmacSHA1");
       mac.init(signingKey);
       byte[] rawHmac = mac.doFinal(value.getBytes());
       byte[] base64Bytes = Base64.encodeBase64(rawHmac);
       return new String(base64Bytes, "UTF-8");
   }

Messages

Destination Address 

 https://updoxqa.com/io/pingWithAuth

Sample Request and Response

Request 

{
    "auth": {
        "applicationId": "updox",
        "applicationPassword": "1234567890",
        "accountId": "account",
        "userId": "user"
    }
}

Response 

{
    "successful": true,
    "responseMessage": "OK",
    "responseCode": 2000
}

Error Codes

This API method will only return the General Error Set.