API Keys
Manage API keys for the Masumi Payment Service API
/api-key-status
This endpoint is used for checking the status of the existing API keys.
Gets api key status
GET / HTTP/1.1
Host: api-key-status
token: YOUR_API_KEY
Accept: */*
API key status
{
"status": "success",
"data": {
"status": "Active",
"token": "masumi_payment_api_key_secret",
"permission": "Admin",
"networkLimit": [
"Preprod"
],
"usageLimited": true,
"RemainingUsageCredits": [
{
"unit": "",
"amount": "10000000"
}
]
}
}
/api-key
These endpoints are used for managing API keys.
Gets api key status
The number of API keys to return
10
Used to paginate through the API keys
GET / HTTP/1.1
Host: api-key
token: YOUR_API_KEY
Accept: */*
{
"data": {
"ApiKeys": [
{
"id": "unique_cuid_v2_of_entry",
"token": "masumi_payment_api_key_secret",
"permission": "Admin",
"usageLimited": true,
"RemainingUsageCredits": [
{
"unit": "",
"amount": "10000000"
}
],
"status": "Active",
"networkLimit": [
"Mainnet"
]
}
]
},
"status": "success"
}
Creates a API key
Whether the API key is usage limited. Meaning only allowed to use the specified credits or can freely spend
true
The permission of the API key
Read
Possible values: POST / HTTP/1.1
Host: api-key
token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 93
{
"usageLimited": "true",
"UsageCredits": [
{
"unit": "",
"amount": "10000000"
}
],
"permission": "Admin"
}
{
"status": "success",
"data": {
"id": "unique_cuid_v2_of_entry_to_delete",
"token": "masumi_payment_api_key_secret",
"permission": "Admin",
"usageLimited": true,
"networkLimit": [
"Preprod"
],
"status": "Active"
}
}
Creates a API key
The id of the API key to update. Provide either id or apiKey
To change the api key token
Whether the API key is usage limited
true
The status of the API key
Active
Possible values: PATCH / HTTP/1.1
Host: api-key
token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 210
{
"id": "unique_cuid_v2_of_entry_to_update",
"token": "api_key_to_change_to",
"UsageCreditsToAddOrRemove": [
{
"unit": "",
"amount": "10000000"
},
{
"unit": "usdm_policy_and_asset_id",
"amount": "-10000000"
}
],
"status": "Active"
}
{
"status": "success",
"data": {
"id": "unique_cuid_v2_of_entry_to_delete",
"token": "masumi_payment_api_key_secret",
"permission": "Admin",
"usageLimited": true,
"networkLimit": [
"Preprod",
"Mainnet"
],
"status": "Active"
}
}
Removes a API key
The id of the API key to be (soft) deleted.
DELETE / HTTP/1.1
Host: api-key
token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 55
{
"id": "id_or_apiKey_unique_cuid_v2_of_entry_to_delete"
}
{
"status": "success",
"data": {
"id": "unique_cuid_v2_of_entry_to_delete",
"token": "masumi_registry_api_key_secret",
"status": "Revoked",
"permission": "Admin",
"usageLimited": true,
"networkLimit": [
"Preprod",
"Mainnet"
],
"deletedAt": "1970-01-20T20:00:36.260Z"
}
}
/rpc-api-keys
Gets rpc api keys, currently only blockfrost is supported (internal)
Used to paginate through the rpc provider keys
The number of rpc provider keys to return
100
GET / HTTP/1.1
Host: rpc-api-keys
token: YOUR_API_KEY
Accept: */*
Blockfrost keys
{
"RpcProviderKeys": [
{
"network": "Preprod",
"id": "unique_cuid_v2",
"rpcProviderApiKey": "blockfrost_api_key",
"rpcProvider": "Blockfrost",
"createdAt": "1970-01-20T20:00:36.260Z",
"updatedAt": "1970-01-20T20:00:36.260Z"
}
]
}
Last updated
Was this helpful?