MANAGEMENT

The management API is used to manage all the aspects of your account. It allows you to create, modify and delete clients, accounts, users and access levels. For using this API you need to use your API key that have MANAGEMENT permission.

Questions?

Don't let uncertainty hold you back. Ask us anything and get the answers you need to take your business to the next level.

LET'S TALK

CLIENTS:

Manage the company information from here, like changing the webhook url where we ll notify that some event happened or just changing the name of the company. Just like that.

Example

Change webhook url

curl -X PATCH https://api.cryptomate.me/management/clients/webhook-url -H 'x-api-key: 1234567890' -H 'Content-Type: application/json' -d '{"webhook_url": "https://mynewwebhookurl.com"}'

GET

Get clients information

Retrieves all the information of the company.

Parameters

Name: x-api-key
Type: string
Description: Identifier used to authenticate a user for the use of the CryptoMate APIs.

GET

/management/clients

Response

{
  "name": "string",
  "last_name": "string",
  "email": "string",
  "social_reason": "string",
  "webhook_url": "string",
}

PATCH

Update Webhook-Url

Modifies the client's webhook-url.

Parameters

PATCH

/management/clients/webhook-url

Response

{
  "name": "string",
  "email": "string",
  "webhook_url": "string"
}

PUT

Update Client-Information

Modifies the client's information.

Parameters

PUT

/management/clients

Response

{
  "name": "string",
  "email": "string",
  "webhook_url": "string"
}

OPERATIONS:

Get all the operations available in the platform. You can use this information to create new credentials for your clients.

Example

Get all operations

curl -X GET https://api.cryptomate.me/management/operations/list -H 'x-api-key: 1234567890'

GET

Get all operations

Returns all the operations available in the platform.

Parameters

Name: x-api-key
Type: string
Description: Identifier used to authenticate a user for the use of the CryptoMate APIs.

GET

/management/operations/list

Response

[
    {
        "id": "string",
        "description": "string"
    }
]

GET

Get a operation

Just returns the operations that you want.

Parameters

GET

/management/operations/:operation-id

Response

{
    "id": "string",
    "description": "string"
}

BLOCKCHAINS:

Get all the blockchains available in the platform. You can use this information to create new credentials for your clients or using every other endpoints that ask for the blockchain where you want to operate.

Example

Get all blockchains

curl -X GET https://api.cryptomate.me/management/blockchains/list -H 'x-api-key: 1234567890'

GET

Get all blockchains

Returns all the blockchains available in the platform.

Parameters

Name: x-api-key
Type: string
Description: Identifier used to authenticate a user for the use of the CryptoMate APIs.

GET

/management/blockchains/list

Response

[
    {
        "id": "string",
        "description": "string"
    }
]

API-KEYS:

Manage the api-keys of your clients. You can create, modify and delete them. This api-keys are used to authenticate the clients in the platform.

Example

Create a new API-Key

curl -X POST https://api.cryptomate.me/management/keys -H 'x-api-key: 1234567890' -H "Content-Type: application/json" -d '{"name": "mynewapikey"}'

GET

Get all keys

Obtains all of the client API-Keys.

Parameters

Name: x-api-key
Type: string
Description: Identifier used to authenticate a user for the use of the CryptoMate APIs.

GET

/management/keys/list

Response

[
    {
        "api_key": "string",
        "name": "string"
    }
]

GET

Get a key

Obtains the information of a key by it's Id.

Parameters

GET

/management/keys/:key-id

Response

{
    "api_key": "string",
    "name": "string"
}

POST

Create a Key

Creates a new API-Key for the client.

Parameters

POST

/management/keys

Response

{
    "api_key": "string",
    "name": "string"
}

PUT

Modify a key

Modifies the information of a key by ID.

Parameters

PUT

/management/keys/:api-key

Response

{
    "api_key": "string",
    "name": "string"
}

DELETE

Delete a key

Deletes a API-Key by it's Id.

Parameters

DELETE

/management/keys/:api-key

Response

None

CREDENTIALS:

Manage the access you give to each key and the permissions you will have for each blockchain, such as only receiving transactions or only accessing one of the blockchains

Example

Create a credential

curl -X POST https://api.cryptomate.me/management/credentials -H 'x-api-key: 1234567890' -H 'Content-Type: application/json' -d '{"api-key": "string", "operation_id": "string", "blockchain_id": "string"}'

GET

Get all credentials for a API-Key

Obtains all credentials for a key.

Parameters

GET

/management/credentials/api-key/:api-key

Response

{
    "id": "string",
    "key": {
        "api_key": "string",
        "name": "string"
    },
    "operation": {
        "id": "string",
        "description": "string"
    }
}

GET

Get a credential information

Obtains a credential by ID.

Parameters

GET

/management/credentials/:credential-id

Response

{
    "id": "string",
    "key": {
      "api_key": "string",
      "name": "string"
    },
    "operation": {
      "id": "string",
      "description": "string"
    }
}

POST

Create a credential

Creates a credential for a API-Key and operation.

Parameters

POST

/management/credentials

Response

{
    "id": "string",
    "key": {
        "api_key": "string",
        "name": "string"
    },
    "operation": {
        "id": "string",
        "description": "string"
    }
}

PUT

Update a credential

Modifies a credential by ID.

Parameters

PUT

/management/credentials/:credential-id

Response

{
    "id": "string",
    "key": {
        "api_key": "string",
        "name": "string"
    },
    "operation": {
        "id": "string",
        "description": "string"
    }
}

DELETE

Delete a credential

Deletes a credential by it's Id.

Parameters

DELETE

/management/credentials/:credential-id

Response

None