REST API requeses and authentication

REST API requests

To authenticate your account, every request made to https://api.uploadcare.com/ MUST be signed. There are two available auth schemes: a simple one with intuitive auth-param and a more sophisticated and secure one that can be used for Signed Requests.

Every request MUST contain the Authorization header where auth-param differs amidst the two authentication methods,

`Authorization: auth-scheme auth-param`

Every request MAY contain the Accept header to specify the accepted data types and API version,

`Accept: application/vnd.uploadcare-v0.5+json`

If no version info is specified, a default API version is used, ver. 0.5 by now.

Uploadcare.Simple auth-scheme

With the Uploadcare.Simple authentication method, auth-param is your public_key:secret_key pair. With this scheme, your Uploadcare project secret_key gets included in every request.

Example request, Uploadcare.Simple

Accept: application/vnd.uploadcare-v0.5+json
Authorization: Uploadcare.Simple public_key:private_key

Uploadcare auth-scheme

With the Uploadcare authentication method:

  • auth-param is a public_key:signature pair, where your secret_key is used to derive signature but is not included in every request itself.
  • You MUST also provide the Date header formatted according to RFC 2822, and the date you provide MUST NOT exceed the 15-minute offset from the server time of the API endpoint. Date gets converted to UTC.

Example request, Uploadcare

Accept: application/vnd.uploadcare-v0.5+json
Date: Fri, 30 Sep 2016 11:10:54 GMT
Authorization: Uploadcare ac58a21ea143ffa4f1af:6ff75027649aadd4dc98c1f784444445d1e6ed82

Building signature

The signature part of the Uploadcare authentication method auth-param MUST be constructed from the following components,

  • Request type (POST, GET, HEAD, OPTIONS).
  • Hex md5 hash of the request body.
  • Content-Type header value.
  • Data header value.
  • URI including path and parameters.

The parameters are then concatenated in textual order using LF: every value sits in a separate line. The result is then signed via SHA1 using secret_key of your project as a key.

Take a look at the Python example of deriving signature; the example request is made to get a list of files,

# importing the needed libraries
import hashlib
import hmac
from email import utils
from datetime import datetime
import time

# specifying the project’s key (demo key is used in the example)
SECRET_KEY = 'demoprivatekey'

# specifying request type
verb = 'GET'

# calculating md5, since we send an empty string, md5 calculations are performed
# for an empty string
content_md5 = hashlib.md5('').hexdigest()

# Content-Type header
content_type = 'application/json'

# Date header
date_header = utils.formatdate(usegmt=True)

# URI
uri = '/files/?limit=1&stored=true'

# forming the final string: concatenating
sign_string = '\n'.join([verb, content_md5, content_type, date_header, uri])

# calculating the signature
signature = hmac.new(SECRET_KEY, sign_string, hashlib.sha1).hexdigest()

# Done

Once signature is derived, it SHOULD be implemented into the request body,

curl	\
     -H "Content-Type: application/json" \
     -H "Accept: application/vnd.uploadcare-v0.5+json" \
     -H "Date: Fri, 30 Sep 2016 12:11:58 -0000" \
     -H "Authorization: Uploadcare demopublickey:170e3a56f5cb70adcb25e6cddb5d34aa8620aca9" \
     "https://api.uploadcare.com/files/?limit=1&stored=true"

Note,

  • All date and time strings used with the API MUST be in the ISO 8601 extended format.
  • For the pyuploadcare implementation of the Uploadcare authentication method, you may refer here.

We’re always happy to help with code, integration, and other stuff. Search our site for more info or post your question in our Community Area.