Authentication

Overview

The Ubikami API authentication mechanism follows the Basic Authentication scheme.
To access our protected endpoints, users must send their credentials as a Base64-encoded string in the Authorization header.
The credentials must be in the format:
email:api_token
The email represents your account email with which you have created your account on Ubikami.
The API token represents your generated API token associated to your account.
After encoding the string using Base64, it should be sent as follows in the request headers for any request to the API:
Authorization: Basic {base64_encoded_string}

Procedure to use Ubikami API

  1. Generate API Token
  2. Create the credentials string and encode it
    • Format the credentials as email:api_token.
      Example: user@example.com:abcdef123456.
    • Convert the string to Base64 format. You can use our Base64 Encoder tool.
      Example : dXNlckBleGFtcGxlLmNvbTphYmNkZWYxMjM0NTY=
  3. Send the request
    • Include the Authorization: Basic {base64_encoded_string} header in any request performed to the API endpoints.
      Example : Authorization: Basic dXNlckBleGFtcGxlLmNvbTphYmNkZWYxMjM0NTY=