Articles

Print

API Authentication

Written by Chris Williams. Posted in API Documentation

Most tasks with the API require authentication against the security system before.  This authentication is done in two steps, Identifying and Authenticating. 



247 Platform API Authentication Cycle

Identify

Request

URL

  • http://console.247platform.com/api/identify/get/[client id]

 

Response

{
   "response":{
      "salt":"560b4j4b",
      "code":"200",
      "isOk":true
   },
   "code":"200"
}

Errors

  • MissingRequiredQueryParameter (code 400),  A parameter is missing from the request

 

 

Authenticate

Request

URL

  • http://console.247platform.com/api/authenticate/get/[client id]?salt=[salt]&code=[authentication code]

Params

  • `salt` (required), String, The salt value provided in the Identify request
  • `code` (required), String, The result of an MD5 of your API key and the salt, without spaces between, e.g.
    $code = md5($apiKey.$salt);

Response

{
   "response":{
      "response":"ok",
      "sessionId":"0ce433ffcca7e3410ds4ssa3317d44c19"
   },
   "code":"200"
}

Errors

  • MissingRequiredQueryParameter (code 400),  A parameter is missing from the request
  • AuthenticationFailed (code 400), Authentication has failed with the provided information