Authentication Mechanism

Every Pikeo API call is signed. The signature depends on the access type (anonymous or logged).
The following parameters are mandatory for all API calls and should be added to those listed afterward.

All the methods in the API require HTTP POST requests both for REST and XMLRPC.

Anonymous Access

Anonymous signature generation
Base64(SHA1(nonce + timestamp + secret))
The nonce, timestamp and secret (associated with an api_key) are concatenated.
The signature is the SHA1 digest of this string encoded in base64.

Parameters

Type Parameter Required Description
String api_key Yes Your api key provided. You can register here if you don't have one.
String api_sig Yes Generated signature using the algorithm from above
String nonce Yes Base64 encoded (cryptographically) random string that should be different for each request
String timestamp Yes Nonce creation timestamp W3DTF format
 e.g. YYYY-MM-DDThh:mm:ssZ

Logged access

Authentified signature generation
Base64(SHA1(nonce + timestamp + secret + UpperCase(Hexa(MD5(userPassword)))))
The nonce, timestamp, secret (associated with an api_key) and the upper case MD5 hexadecimal digest of the user_password are concatenated.
The signature is the SHA1 digest of this string encoded in base64.

Parameters

Type Parameter Required Description
String api_key Yes Your api key provided. You can register here if you don't have one.
String api_sig Yes Generated signature using the algorithm from above
String nonce Yes Base64 encoded (cryptographically) random string that should be different for each request
String timestamp Yes Nonce creation timestamp W3DTF format e.g. YYYY-MM-DDThh:mm:ssZ
String login Yes The pikeo username trying to call the method in authenticated mode.
This value corresponds to the user_password used when computing the signature

version 9 as of 1 year ago by jeremy

Comments

New comments are not being accepted at this time.