Using the API

  1. Overview
  2. Basic Auth
  3. OAuth
  4. Troubleshooting

Basic Auth

Basic Auth is available from BaseKit 7.42 onwards and can only be used over HTTPS. This is the preferred mechanism of authentication over OAuth as it is far simpler.

All good HTTP clients will support this method of authentication out of the box. With curl it’s as simple as:

curl -u foobar:password https://rest.brand-domain.tld/users

If you receive a 401 Unauthorized response it means that the credentials provided are invalid.

Receiving a 403 Forbidden means that you are authorized successfully but do not have access to the resource.