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.

REQUIRES API KEY Authentication (+READ)

get

Gets api key status

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url './../api/v1//api-key-status/' \
  --header 'token: YOUR_API_KEY'

200

200

{
  "status": "success",
  "data": {
    "status": "Active",
    "token": "masumi_payment_api_key_secret",
    "permission": "Admin",
    "networkLimit": [
      "Preprod"
    ],
    "usageLimited": true,
    "RemainingUsageCredits": [
      {
        "unit": "lovelace",
        "amount": "10000000"
      }
    ]
  }
}

API key status

/api-key

These endpoints are used for managing API keys.

REQUIRES API KEY Authentication (+admin)

get

Gets api key status

Authorizations

Query parameters

limitnumber · min: 1 · max: 100 · default: 10optional

The number of API keys to return

cursorTokenstring · max: 550optional

Used to paginate through the API keys

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url './../api/v1//api-key/' \
  --header 'token: YOUR_API_KEY'

200

400

401

500

200

{
  "data": {
    "ApiKeys": [
      {
        "id": "unique_cuid_v2_of_entry",
        "token": "masumi_payment_api_key_secret",
        "permission": "Admin",
        "usageLimited": true,
        "RemainingUsageCredits": [
          {
            "unit": "lovelace",
            "amount": "10000000"
          }
        ],
        "status": "Active",
        "networkLimit": [
          "Mainnet"
        ]
      }
    ]
  },
  "status": "success"
}

Api key status

REQUIRES API KEY Authentication (+admin)

post

Creates a API key

Authorizations

Body

usageLimitedstring · default: "true"optional

Whether the API key is usage limited. Meaning only allowed to use the specified credits or can freely spend

UsageCreditsobject[]required

The credits allowed to be used by the API key. Only relevant if usageLimited is true.

networkLimitstring · enum[] · max: 3 · default: ["Mainnet","Preprod"]optional

The networks the API key is allowed to use

permissionstring · enum · default: "Read"optional

The permission of the API key

Options: Read, ReadAndPay, Admin

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url './../api/v1//api-key/' \
  --header 'token: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "usageLimited": "true",
    "UsageCredits": [
      {
        "unit": "lovelace",
        "amount": "10000000"
      }
    ],
    "permission": "Admin"
  }'

200

400

401

500

200

{
  "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"
  }
}

API key deleted

REQUIRES API KEY Authentication (+admin)

patch

Creates a API key

Authorizations

Body

idstring · max: 150required

The id of the API key to update. Provide either id or apiKey

tokenstring · min: 15 · max: 550optional

To change the api key token

UsageCreditsToAddOrRemoveobject[] · max: 25optional

The amount of credits to add or remove from the API key. Only relevant if usageLimited is true.

statusstring · enum · default: "Active"optional

The status of the API key

Options: Active, Revoked

networkLimitstring · enum[] · max: 3 · default: ["Mainnet","Preprod"]optional

The networks the API key is allowed to use

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url './../api/v1//api-key/' \
  --header 'token: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "unique_cuid_v2_of_entry_to_update",
    "token": "api_key_to_change_to",
    "UsageCreditsToAddOrRemove": [
      {
        "unit": "lovelace",
        "amount": "10000000"
      },
      {
        "unit": "usdm",
        "amount": "-10000000"
      }
    ],
    "status": "Active"
  }'

200

400

401

500

200

{
  "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"
  }
}

API key deleted

REQUIRES API KEY Authentication (+admin)

delete

Removes a API key

Authorizations

Body

idstring · max: 150required

The id of the API key to be (soft) deleted.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url './../api/v1//api-key/' \
  --header 'token: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "id_or_apiKey_unique_cuid_v2_of_entry_to_delete"
  }'

200

400

401

500

200

{
  "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"
  }
}

API key deleted

/rpc-api-keys

REQUIRES API KEY Authentication (+ADMIN)

get

Gets rpc api keys, currently only blockfrost is supported (internal)

Authorizations

Query parameters

cursorIdstring · min: 1 · max: 250optional

Used to paginate through the rpc provider keys

limitnumber · min: 1 · max: 100 · default: 100optional

The number of rpc provider keys to return

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url './../api/v1//rpc-api-keys/' \
  --header 'token: YOUR_API_KEY'

200

200

{
  "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"
    }
  ]
}

Blockfrost keys