Request Signature [Deprecated]


Deprecation Warning

API authentication via request signature is an outdated authentication. The documentation below has been included for your reference. Please migrate existing code to use Service Account authentication.

Request signature authentication is the process of creating an encrypted token unique to a set of request parameters and their values. It was useful when requests were made insecurely or needed to be expirable. However, superior and more simplistic security practices have made this approach obsolete.

Calculating a Signature

In order to generate a request signature you will need the following information:

api_key: This is the token from the corresponding to the project you wish to consume from.
api_secret: This is a secret API key corresponding to the project.
expire: UTC time in seconds; used to expire an API request.
all other request parameters: All of the information for the API request being performed

Calculating the signature is done in parts:

  1. Alphabetically sort all parameters being used in the request. This excludes your api_secret
  2. alphabetically sorted order, concatenate the parameter and parameter value joined by an equal sign. For example: param1=paramvalue1param2=paramvalue2
  3. append the api_secret to the string of concatenated parameters.
  4. md5 hash the final string

The resulting hash is the request signature.

# (psuedo code)
# all query parameters going to be sent out with the request
request_parameters = {
   api_key: '123',
   unit: 'hour',
   interval: '24',
   event: '["pages"]',
   expire: '1248499222',

sorted_parameter_names = sort(keys(request_parameters))
combined_params = ''

for param in sorted_parameter_names:
	combined_params += 	param + "=" + request_parameters[param]

request_signature = md5(combined_params + api_secret)request_signature = md5(combined_params + api_secret)

Authenticating with a Request Signature

The generated signature needs to be provided with the parameters you used to calculate it. It will not work if any parameters or values change and it will not be valid after the expiry time.

Your URL should look similar to this however varying on the endpoint you are requesting data from:

Request with Signature