Local Mail Docs

Basic Authentication (API key)

Basic access authentication is a way for a user to provide a username and password or SID and Access key when making an API request.

Basic authentication is a combination of your SID and Access key.

For example,
SID is "98XghI5iwZwi8m6j1qGAE4bafZfCQjjPNHWk84QA"
accessKey is "E6XoZRvg3hhsP9NlJ5NIFnA9u4KI6IVrLNCiMRfv"

Follow the Steps to create your basic Auth:

Authorization: Basic X
  • To the left of the colon is the header key: Authorization
  • To the right of the colon is the header value: Basic X
X should be replaced with the Base64 encoded version of the users credentials and it is the only value that needs to be replaced in this header.

How to base64 encode

The first step is to base64 encode your credentials (your sid and accesskey).
You can use text editor like Notepad++ or some service such as this one, if you are okay with entering your credentials on a third-party website (at your own risk): https://www.base64encode.org/
If you use the online encoder, follow these steps:
  1. 1.
    In the online encoder, enter your sid and accesskey, separated by a colon (sid:accesskey)
  2. 2.
    Click ENCODE
  3. 3.
    Copy the encoded value and go to the next step
Above sid and accesskey Base64 encoded: OThYZ2hJNWl3WndpOG02ajFxR0FFNGJhZlpmQ1FqalBOSFdrODRRQTpFNlhvWlJ2ZzNoaHNQOU5sSjVOSUZuQTl1NEtJNklWckxOQ2lNUmZ2

Need More Help?

If you need any further Help During your onboarding or have questions related to API Keys, you can reach out to our support team at [email protected]