API Key Based Authentication

by
Odoo

53.40

v 17.0 Third Party 2
Live Preview
Availability
Odoo Online
Odoo.sh
On Premise
Odoo Apps Dependencies Discuss (mail)
Community Apps Dependencies
Lines of code 1055
Technical Name api_auth_apikey
LicenseOPL-1
Websitehttps://ekika.co
Versions 15.0 16.0 17.0
You bought this module and need support? Click here!
Availability
Odoo Online
Odoo.sh
On Premise
Odoo Apps Dependencies Discuss (mail)
Community Apps Dependencies
Lines of code 1055
Technical Name api_auth_apikey
LicenseOPL-1
Websitehttps://ekika.co
Versions 15.0 16.0 17.0

API-Key Authentication

This module serves as a fundamental building block within the API Framework. To implement API-key based authentication in your API configuration system, it is essential to integrate this module. Keep in mind that this module is not designed to function independently; it relies on the API Framework Base (api_framework_base) as its foundation to seamlessly operate with various API authentication mechanisms.

Auth API-Key Introduction

API-Key authentication is a simple and effective way to secure your API endpoints by requiring clients to include an API key in the request headers. This authentication method ensures that only authorized users can access your API resources.

How It Works

When making a request to an API endpoint that requires authentication, clients must include an X-API-Key header in the HTTP request. The value of this header should be the API key provided to the client by the API provider.

Headers

Key Value
X-API-Key Your-API-key-value

Example

Here’s an example using cURL:

curl -X GET "https://api.example.com/resource" -H "X-API-Key: your_api_key_here"

Here’s an example using Python:

import requests

# Replace 'your_api_key_here' with your actual API key
api_key = 'your_api_key_here'
api_url = 'https://api.example.com/resource'

# Make an authenticated GET request
headers = {
    'X-API-Key': api_key
}

response = requests.get(api_url, headers=headers)

Auth-API-Key Postman

Configuring API-Key Authentication

API-Key-Authentication-Setting-1

API-Key-Authentication-Setting-2

Odoo Proprietary License v1.0

This software and associated files (the "Software") may only be used (executed,
modified, executed after modifications) if you have purchased a valid license
from the authors, typically via Odoo Apps, or if you have received a written
agreement from the authors of the Software (see the COPYRIGHT file).

You may develop Odoo modules that use the Software as a library (typically
by depending on it, importing it and using its resources), but without copying
any source code or material from the Software. You may distribute those
modules under the license of your choice, provided that this license is
compatible with the terms of the Odoo Proprietary License (For example:
LGPL, MIT, or proprietary licenses similar to this one).

It is forbidden to publish, distribute, sublicense, or sell copies of the Software
or modified copies of the Software.

The above copyright notice and this permission notice must be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

Please log in to comment on this module

  • The author can leave a single reply to each comment.
  • This section is meant to ask simple questions or leave a rating. Every report of a problem experienced while using the module should be addressed to the author directly (refer to the following point).
  • If you want to start a discussion with the author or have a question related to your purchase, please use the support page.