Version: 10.0

Using API Keys

Starting in rWeb 9.2.0, instead of needing to use cookie based authentication for the API, you can utilize API keys. In order to use a generated token, users should include it in an Authorization header.

Authorization: token [Your token]

token is the auth-scheme, and can use any case formatting and allows any whitespace values leading up to your token value. So if your token is 6d776df80f7ef2eba4dfd0485c776642, the following are all legal headers:

Authorization: token 6d776df80f7ef2eba4dfd0485c776642
Authorization: Token  6d776df80f7ef2eba4dfd0485c776642
Authorization: TOKEN 6d776df80f7ef2eba4dfd0485c776642

This header will need to be set on every API request. API key authentication does not establish a session or set session cookies.

cURL example

$ curl -H 'Authorization: token 903509033849c9d6a899ef9a64cb8795' \
       -H 'Accept: application/json' \
       -k \
       -w "\nHTTP_STATUS:%{http_code}\n" \
       https://rweb1/authentication

cURL example​

cURL example