Получение API ключей

Метод позволяет получить API ключи пользователя

Запрос:

Параметр

Обязателен

Тип

Описание

userId

Да

Строка

Идентификатор пользователя

limit

Да

Число

Лимит на количество ключей в ответе

offset

Да

Число

Сдвиг (для пагинации)

Ответ:

Параметр

Тип

Описание

keys

Массив объектов

Массив объектов API ключей

total

Число

Общей количество API ключей пользователя

Параметр keys является массивом следующих объектов:

Параметр

Тип

Описание

id

Строка

Идентификатор API ключа

public

Строка

Публичный ключ

secret

Строка

Часть приватного ключа

alias

Строка

Название API ключа

createdAt

Строка

Дата создания ключа

Получение API ключей

post
Header parameters
x-api-public-keystringOptional

Публичный API-ключ

x-api-signaturestringOptional

Подпись тела запроса приватным API-ключем

Content-typestringOptional

Тип тела запроса

Example: application/json
Body

Тело запроса получения апи ключей

userIdstringOptional

Идентификатор пользователя

Example: ed83d19f-30ef-4b3f-bca9-edd2c7714b16
limitintegerOptional

Количество элементов на странице

offsetintegerOptional

Количество элементов для пропуска

Responses
200Success
application/json
post
POST /partner/api/get-api-keys HTTP/1.1
Host: ocp.onchainpay.io
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "userId": "ed83d19f-30ef-4b3f-bca9-edd2c7714b16",
  "limit": 1,
  "offset": 1
}
200Success
{
  "success": true,
  "response": {
    "keys": [
      {
        "id": "fdcedae3-b06a-4c9f-be0e-0933b476f98d",
        "public": "QoK/3fZY8QK68z3DFvwcTgN4LSTDa8pi6rUNbGQfM4EgKCyt9whSFkbIQOFIAsGKlCZlCE1gyvi0Q6vf77KHKw==",
        "secret": "TLS9BLlNCOHTlAEhHGsl8P77gkaUleEnnJv3r4oL2n8owM8c33ALZCaVe3cBq4HEkGm+Tx1rNI6CPUXc8r7fBg==",
        "alias": "Integration key",
        "createdAt": "2025-06-09T13:18:11.467Z"
      }
    ],
    "total": 1
  }
}

Last updated