Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

To use your API keys, all you need to do is include them in the request in the Authorisation header – the simplest way to do this is header

If you're able to include them in the header specifically (eg. your software doesn't allow it), an alternate approach is to include them as follows in the URL;

https://<your key>:<your secret>@<your address>secret>@<yourcompany>.vtevents.com.au/....


Generating the authorisation header

The Authorisation header is constructed as follows:

  1. Username and password are combined into a string "username:password"
  2. The resulting string is then encoded using Base64 encoding
  3. The authorisation method and a space i.e. "Basic " is then put before the encoded string.

For example, if the user agent uses 'my username' as the username and 'my secret password' as the password then the header is formed as follows:

Authorization: Basic bXkgdXNlcm5hbWU6bXkgc2VjcmV0IHBhc3N3b3Jk

Example in PHP;

$encoded = "Authorization: Basic ".base64_encode($username.":".$password)