Справочник API

API клиентского портала

Создает подписанные URL-адреса клиентского портала MakePay для сохраненных клиентов.

Создать ссылку на портал

Создает ссылку на портал клиентов MakePay из сохраненного профиля клиента MakePay. Создавайте ссылку только тогда, когда клиент или merchant вводит выставление счетов, а затем перенаправляйте или открывайте возвращенный URL.

POST /api/partner/v1/makepay/customers/{customerId}/portal

customerId принимает сохраненный UUID клиента или UID клиента. Тело запроса пусто.

curl

curl -X POST "https://www.makecrypto.io/api/partner/v1/makepay/customers/CUSTOMER_ID/portal" \
  -H "x-makecrypto-key-id: MAKEPAY_API_KEY_ID" \
  -H "x-makecrypto-key-secret: MAKEPAY_API_SECRET" \
  -H "Accept: application/json"

Аутентификация

Интеграции серверов аутентифицируются с помощью ключа API MakePay. Сеансы браузера могут вызывать маршрут информационной панели на уровне предприятия, если у аутентифицированного пользователя есть settings.manage в выбранной команде. Запросы с ключом API не передают идентификатор компании в URL, поскольку ключ уже принадлежит компании.

Заголовок	Значение	Примечания
`x-makecrypto-key-id`	ID ключа MakePay API	Начинается с `mk_makepay_` для платежных API MakePay.
`x-makecrypto-key-secret`	Одноразовый API secret	Показывается только при создании ключа. Храните его в серверном менеджере секретов.

Отвечать

Маршрут возвращает объект клиента плюс подписанную ссылку в urls.customerPortal.

json

{
  "ok": true,
  "companyId": "acct_123",
  "customer": {
    "id": "b834dd77-69b8-41a9-a4b6-95bc9dd14c2d",
    "uid": "cus_01hzy4k6p4w9y2x7e2z7n8a2xm",
    "email": "buyer@example.com",
    "name": "Ada Lovelace",
    "clientId": "client_1042",
    "metadata": {
      "source": "api"
    },
    "createdAt": "2026-04-20T10:00:00.000Z",
    "updatedAt": "2026-04-20T10:00:00.000Z",
    "urls": {
      "customerPortal": "https://makepay.io/billing?company=acct_123&customer=cus_01hzy4k6p4w9y2x7e2z7n8a2xm&expires=1776765600&signature=8d1f..."
    }
  },
  "expiresAt": "2026-04-21T10:00:00.000Z"
}

Параметры подписанного URL

Возвращенный портал URL имеет следующую форму:

https://{makepay-or-verified-merchant-domain}/billing?company={companyId}&customer={customerUid}&expires={unixSeconds}&signature={hexHmac}

Параметр	Оценки
`company`	Идентификатор учетной записи компании MakeCrypto, которой принадлежит клиент.
`customer`	UID клиента MakePay с объемом деятельности этой компании.
`expires`	Временная метка Unix в секундах. Ссылки действительны в течение 24 часов.
`signature`	Подпись HMAC для версии, компании, клиента и срока действия.

MakePay проверяет подпись и срок действия перед загрузкой данных с портала. Не храните URL-адреса портала постоянно. Восстанавливает новую ссылку при каждом нажатии кнопки.

Область применения портала

На портале отображаются только данные, соответствующие подписанной компании и клиенту:

Сводная информация о профиле клиента и редактируемое отображаемое имя.
История платежей по электронной почте или идентификатору клиента.
Активные или неоплаченные платные ссылки с размещенными URL-адресами MakePay.
Подписки по электронной почте или идентификатору клиента в metadata.
Приостанавливайте, повторно активируйте и отменяйте действия для поддерживаемых состояний подписки.

Электронная почта, идентификатор клиента, PDF-файлы, способы оплаты, лицензионные ключи, потоки смены плана и возобновления отмененной подписки не изменяются в первой версии портала.