Class: CryptomateApi::Management::Key

Inherits:
Base
  • Object
show all
Defined in:
lib/cryptomate_api/management/key.rb

Overview

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.

Instance Method Summary collapse

Methods inherited from Base

#initialize

Constructor Details

This class inherits a constructor from CryptomateApi::Base

Instance Method Details

#create_key(name) ⇒ Object

Create a key cryptomate.me/docs/management#create-a-key Response: [

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

]

Parameters:

  • name (String) —

    (Alias name of the API-Key to create.)



45
46
47
 
# File 'lib/cryptomate_api/management/key.rb', line 45

def create_key(name)
  self.class.post('/management/keys/create', body: { name: }.to_json)
end

#delete_key(api_key) ⇒ Object

Delete a key cryptomate.me/docs/management#delete-a-key

Parameters:

  • api_key (String) —

    (Id of the API-Key. Ex: master-ac8ff424-426f-46a7-94c3-13932c6e8adf)



67
68
69
 
# File 'lib/cryptomate_api/management/key.rb', line 67

def delete_key(api_key)
  self.class.delete("/management/keys/#{api_key}")
end

#get_all_keys ⇒ Object

Get all keys cryptomate.me/docs/management#get-all-keys Response: [

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

]



18
19
20
 
# File 'lib/cryptomate_api/management/key.rb', line 18

def get_all_keys
  self.class.get('/management/keys/list')
end

#get_key(key_id) ⇒ Object

Get a specific key cryptomate.me/docs/management#get-a-key Response: [

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

]



31
32
33
 
# File 'lib/cryptomate_api/management/key.rb', line 31

def get_key(key_id)
  self.class.get("/management/keys/#{key_id}")
end

#modify_key(key_name, new_api_key_value) ⇒ Object

Modify a key cryptomate.me/docs/management#modify-a-key Response: [

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

]

Parameters:

  • key_name (String) —

    (Name of the key to modify.)

  • new_api_key_value (String) —

    (New api-key value.)



60
61
62
 
# File 'lib/cryptomate_api/management/key.rb', line 60

def modify_key(key_name, new_api_key_value)
  self.class.put("/management/keys/#{key_name}", body: { api_key: new_api_key_value }.to_json)
end