Log in

Platform API: fulfillment and redeem

Platform lifecycle: learn about new codes → realize to customer → report redemption. Primary sync: promo-codes/changes.

Platform API for sales channels. Prefix /v1/platform/, keys bk_plt_*. Catalog is deny-by-default (catalog rules required).

Who this section is for

Audience: Marketplaces and pharmacy chains. Key bk_plt_* — your catalog only (deny by default).

How to work with this API

Platform lifecycle: learn about new codes → realize to customer → report redemption. Primary sync: promo-codes/changes.

Base URL

  • Production: https://api-external.promanta.ru
  • Local: http://localhost:7314

Authentication

X-Api-Key: bk_plt_… header. Platform id is bound to the key.

Configure API key and webhook in platform drawer.

Request and response format

All methods are POST with JSON { "meta": {}, "data": {} }. Response: success, data, meta.

Methods by workflow

0. Start: profile and webhook

Verify key, catalog rules, webhook status.

1. Catalog sync

Webhook incoming.completed or poll events/changes.

2. Deliver code to customer

Checkout: get full code → realize. Campaigns — realize-batch.

3. Redemption

After customer activation — report-bulk (realized → redeemed).

MCP

Same operations via MCP at /mcp/internal, /mcp/supplier, /mcp/platform.

Request example (smoke test)

{
  "meta": { "requestId": "smoke-001" },
  "data": {}
}

Response example

{ "success": true, "data": { "platformId": "…", "name": "Ригла", "webhookConfigured": true, "catalogRulesCount": 3 } }

cURL

curl -X POST "https://api-external.promanta.ru/v1/platform/profile/get" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: bk_plt_YOUR_KEY" \
  -d '{"data": {}}'
Platform API: fulfillment and redeem — PROMANTA