BioTech Open Platform Docs
简体中文English
Type to search documentation.

Retrieve Caller Information

Use /openapi/profile to verify the Access Token, endpoint registration, and application grant.

View as MarkdownOpen in ChatGPTOpen in Claude

Endpoint information

ItemValue
MethodGET
Request URLhttps://backend.biotech-mkt.com/openapi/profile
Path/openapi/profile
AuthenticationBearer Access Token
PermissionEndpoint must be enabled and granted to the application
Rate limitConfigured per application and endpoint
Acceptapplication/json

Response

The HTTP status, duration, and response body appear here after the request is sent.

This diagnostic endpoint returns the application and request context associated with the current Access Token.

Request parameters

An Access Token is required. A platform administrator must also register and enable this endpoint and grant it to the current application.

This endpoint has no query parameters or request body. Send the following header:

HeaderTypeRequiredDescription
AuthorizationstringYesBearer <access_token>

Request example

Terminal window
curl "https://backend.biotech-mkt.com/openapi/profile" \
  --header "Authorization: Bearer $OPENAPI_ACCESS_TOKEN"

Response fields

FieldReturn typeDescription
codeintegerBusiness status code; 200 on success
messagestringResponse message
dataobjectCaller context
app_idintegerInternal OpenAPI application ID
app_keystringApp Key of the current application
app_namestringCurrent application name
token_idintegerInternal token record ID, not the full token
access_expires_atstringAbsolute Access Token expiration time
request_methodstringCurrent request method
request_pathstringCurrent request path

Response example

json
{
  "code": 200,
  "message": "Success",
  "data": {
    "app_id": 1,
    "app_key": "ak_xxx",
    "app_name": "Order Data Application",
    "token_id": 12,
    "access_expires_at": "2026-08-27 12:00:00",
    "request_method": "GET",
    "request_path": "/openapi/profile"
  }
}

Errors and rate limits

This endpoint can return 401, 403, 404, 405, 429, or 503. Limits are counted independently by application ID and endpoint ID. See Errors and Rate Limits for response headers and handling guidance.

Integration acceptance

For an initial integration, verify that:

  1. Both the HTTP status and response code are 200.
  2. app_key matches the application delivered by the administrator.
  3. request_method is GET and request_path is /openapi/profile.
  4. The response includes X-Request-Id and the current endpoint rate-limit status headers.

Last updated Aug 27, 2026