API Key Overview

The purpose of an API key is to function as a unique, confidential string of characters that authenticates and authorizes a user or application when accessing an API. It serves to identify the calling program to the API, enabling the service to monitor usage for billing, manage quotas, and regulate data access. API keys are obtained by registering for an account with an API provider, then navigating to their developer dashboard or settings to generate a new key.

API Key performs several key functions:

• Authentication: Verifies the identity of the application or user making a request to the API.
• Authorization: Grants the application permission to access specific resources or services via the API.
• Manage Content: This Allows developers to builds applications ans systems to add & manage media into the platform.
• Usage Tracking: Allows the API provider to monitor usage, enforce rate limits, and manage service quotas.
• Billing: Associates API requests with the appropriate user or project for billing purposes.

To acquire an API key through UI DashBoard

1. Navigate the the Page: Click the user badge (top right of the screen), navigate to Profile -> API KEY
2. Create New API Key: Click the New Key button. A popup modal should appear on the screen
3. Enter the Name of the Key: Enter a unique name you to identify this API_Key
4. Choose the Organization: Click the organization you want the API_Key to be associated with.
5. Choose Key Access: Choose the actions you would like this API_Key to be able to perfomrm
   • Read: The API_Key can perform read actions with HTTP GET requests
   • Create: The API_Key can perform write actions with HTTP POST requests
   • Update: The API_Key can perform update actions with HTTP PUT requests
   • Delete: The API_Key can perform delete/removal actions with HTTP DELETE requests
   • Manage: The API_Key can perform actions to manage the organization's HTTP ,GET, POST,PUT, and DELETE requests
6. Save: Submit the key to be generated
7. Copy and Secure the Key: Copy the generated key and store it securely, as it may only be displayed once.

Query Example (Python)

import requests
url = "https://api.boltonsea.com/media/179/versions"
payload = {}
headers = "X-API-KEY": "EXAMPLE-API-KEY-123X..."
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)

Note: Append your API_Key with every API request in the request header using "X-API-KEY" key as displayed in the code example

For security best practices

• Do not expose keys publicly: Treat your API key with the same level of confidentiality as a password.
• Store keys securely: For production applications, utilize environment variables or dedicated key management services.
• Restrict access: Whenever possible, limit your API key's access to only the specific APIs or data it requires.

Should you have any inquiries regarding Media Groups or require additional assistance, please contact us through the contact-us page.