Alfred

The Tagshelf API namespace serves as a dedicated domain within the API for platform status and identity queries.

This namespace is tailored to provide essential functionalities related to the operational status and user context of the platform. It encompasses endpoints that are crucial for system health checks, user identity verification, and basic connectivity tests.

These endpoints are integral for users and administrators to effectively interact with, monitor, and manage their experience on the platform.

Check Platform Operational Status

GET https://<env>.tagshelf.com/api/tagshelf/status

This endpoint offers a quick way to check the overall operational status of the platform. It returns information indicating whether the system is functioning normally or experiencing any issues.

Headers

Name	Type	Description
Content-Type*	string	application/json
Authorization	string	Bearer <access_token> or amx <hmac_token>
X-TagshelfAPI-Key	string	<app_api_key>

200 OK

{
  "currentVersion": "1.11.1.0",
  "status": "Online"
}

Retrieve User Identity Information

GET https://tagshelf.host/api/tagshelf/who-am-i

This endpoint provides information about the currently authenticated user. When accessed, it returns details such as the user's username, role, and other relevant identity attributes. This is particularly useful for applications needing to confirm the identity and access level of a user within the platform.

Headers

Name	Type	Description
Content-Type*	string	application/json
Authorization	string	Bearer <access_token> or amx <hmac_token>
X-TagshelfAPI-Key	string	<app_api_key>

200 OK

{
    "request_origin_ip_address": "127.0.0.1",
    "authentication_type": "HMAC",
    "roles": [
        "Account Admin",
        "User",
        "Uploader"
    ],
    "user_name": "[e-mail]",
    "name": "Alfred",
    "last_name": "Pennyworth",
    "user_id": "8854fc5e-6207-45e2-9b61-46550f9bea57",
    "status": "active",
    "company_id": "644ca02e-762c-4ca7-a818-d3d5b24d5565",
    "company_name": "Tagshelf LLC",
    "app_id": "00000000-0000-0000-0000-000000000000",
    "app_name": null
}

Conduct a Basic Connectivity Test

GET https://tagshelf.host/api/tagshelf/ping

The ping endpoint is used to perform a basic connectivity test to the platform. It responds with a simple message (e.g., "pong") to confirm that the platform is reachable and responding to API requests.

This is a basic tool for checking connectivity and ensuring that the API is online and responsive.

Headers

Name	Type	Description
Content-Type*	string	application/json
Authorization	string	Bearer <access_token> or amx <hmac_token>
X-TagshelfAPI-Key	string	<app_api_key>

200 OK

{
    "pong": "[e-mail]"
}