Skip to main content

Authentication

Welcome to the McEasy API Authentication Guide. As a valued user of McEasy's services, you're about to embark on a journey that will enable you to seamlessly integrate and interact with our robust suite of APIs. McEasy is committed to providing a secure and efficient experience for all our users, and this guide is a crucial step in that direction.

APIs (Application Programming Interfaces) are the backbone of modern software interactions, enabling different systems to communicate and exchange data in a structured and predictable manner. At McEasy, we understand the importance of secure and reliable API access. That's why we've implemented a straightforward yet robust authentication process to protect your data and ensure that only authorized users can access our services.

In this guide, we will walk you through the process of obtaining an API token - your key to accessing McEasy's API. This token acts as a secure means of identifying and authenticating your requests to our servers. We'll provide step-by-step instructions on how to generate this token, how to include it in your API requests, and best practices for managing and protecting your API credentials.

By the end of this guide, you'll be equipped with all the necessary information to confidently and securely use the McEasy API, enabling you to harness the full power of our platform.

Let's get started!

Getting Your API Token​

Before making API requests, you need to obtain an API token. This token is unique to your account and should be kept confidential. Follow these steps to create your token:

  1. Access Settings: Log in to your McEasy account. Navigate to the "Settings" section.
  2. Navigate to API Token: Within Settings, find and select the "API Token" option.
  3. Navigate to New Version: Click on "New Version" to generate a new token.
  4. Create New Token: Click on "Create Token", put the token "label", and click save.
  5. Copy Your Token: Once your token is generated, make sure to copy and keep it secure. You will need this token for your API requests.

Using Your API Token​

To authenticate your API calls, you need to include the API token in the header of your HTTP requests. Here's how you do it:

Authorization Header​

Your API token should be included in the Authorization header of each request. The header should use the Bearer authentication scheme. Here's an example of what the header should look like:

Authorization: Bearer {YOUR_API_TOKEN}

Replace {YOUR_API_TOKEN} with the token you generated in the previous steps.

Example API Request​

Here's a basic example of how to make an authenticated request to the McEasy API using cURL:

curl -X GET 'https://api.mceasy.com/...' \ -H 'Authorization: Bearer YOUR_API_TOKEN'

Replace https://api.mceasy.com/... with the actual endpoint you wish to access.

Best Practices​

  • Keep Your Token Secure: Treat your API token like a password. Do not share it with others and do not expose it in client-side code.

  • Revoke & Regenerate Tokens if Compromised: If you believe your token has been compromised, revoke it and create a new one immediately via the Settings.