Get API keys

The method allows you to get user's API keys

Request:

Parameter	Required	Type	Description
userId	Yes	String	User ID
limit	Yes	Number	Limit on the number of keys in the response
offset	Yes	Number	Offset (for pagination)

Response:

Parameter	Type	Description
keys	Array of objects	Массив объектов API ключей
total	Number	Общей количество API ключей пользователя

The keys parameter is an array of the following objects:

Parameter	Type	Description
id	String	Api key ID
public	String	Public key
secret	String	Secret key
alias	String	Alias
createdAt	String	Creation date

Get API keys

POSThttps://ocp.onchainpay.io/partner/api/get-api-keys

Header parameters

Body

application/json

userIdstring

User ID

Example: "2d611a16-1ab4-4d28-8cc5-943b5f232a95"

limitinteger

Number of elements per page

offsetinteger

Number of items to skip

Response

200

Body

application/json

success*boolean

Request success indicator

response*GetPartnerApiKeysResponse (object)

The body of the api key receipt response

Request

JavaScriptCurlPython

const response = await fetch('https://ocp.onchainpay.io/partner/api/get-api-keys', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "success": false,
  "response": {
    "keys": [
      {
        "id": "bd352a86-3509-4c91-b622-e65e1e3da0bf",
        "public": "QoK/3fZY8QK68z3DFvwcTgN4LSTDa8pi6rUNbGQfM4EgKCyt9whSFkbIQOFIAsGKlCZlCE1gyvi0Q6vf77KHKw==",
        "secret": "TLS9BLlNCOHTlAEhHGsl8P77gkaUleEnnJv3r4oL2n8owM8c33ALZCaVe3cBq4HEkGm+Tx1rNI6CPUXc8r7fBg==",
        "alias": "Integration key",
        "createdAt": "2024-08-15T15:17:13.804Z"
      }
    ]
  }
}