Verify platform API key

Verify bk_plt_ key, catalog rules count, webhook status.

Verify bk_plt_ key, catalog rules count, webhook status.

Why this method exists

Verify bk_plt_ key, catalog rules count, webhook status.

When to use

Go-live smoke test.

Endpoint

POST /v1/platform/profile/get

Authentication: X-Api-Key header (prefix bk_plt_). Do not send projectId or actor id in body — they come from the key.

Scope: platform:catalog:read

Request example

{
  "meta": { "requestId": "optional-uuid" },
  "data": {}
}

Response example

{
  "success": true,
  "data": {
    "platformId": "platform-uuid",
    "name": "Ригла",
    "webhookConfigured": true,
    "catalogRulesCount": 3,
    "catalogSuppliers": [
      { "supplierId": "c219ef09-…", "supplierName": "Промомед" }
    ]
  }
}

Errors

  • UNAUTHORIZED / ACCESS_DENIED — access denied
  • VALIDATION_ERROR — invalid body
  • NOT_FOUND — resource not found
  • RATE_LIMIT_EXCEEDED (429) — rate limit

cURL

curl -X POST "https://api-external.promanta.ru/v1/platform/profile/get" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{"data": {}}'

See also

wiki.ratingPrompt

0 (0 оценок)
Verify platform API key — PROMANTA