KeyApi

KeyApi

new KeyApi()

Version:
  • 1.0

Key service.

Methods

getKey(xChainId, keyId, callback)

GetKey Find key info

Parameters:
Name Type Description
xChainId String

Klaytn chain network ID (1001 or 8217)
keyId String
callback KeyApi~getKeyCallback

The callback function, accepting three arguments: error, data, response data is of type: Key

keyCreation(xChainId, opts, callback)

KeyCreation You can create key up to 100

Parameters:
Name Type Description
xChainId String

Klaytn chain network ID (1001 or 8217)
opts Object

Optional parameters

Properties
Name Type Description
body KeyCreationRequest
callback KeyApi~keyCreationCallback

The callback function, accepting three arguments: error, data, response data is of type: KeyCreationResponse

keySignData(xChainId, keyId, opts, callback)

KeySignData Sign the data using key

Parameters:
Name Type Description
xChainId String

Klaytn chain network ID (1001 or 8217)
keyId String
opts Object

Optional parameters

Properties
Name Type Description
xKrn String
body KeySignDataRequest
callback KeyApi~keySignDataCallback

The callback function, accepting three arguments: error, data, response data is of type: KeySignDataResponse

Type Definitions

getKeyCallback(error, data, response)

Callback function to receive the result of the getKey operation.

Parameters:
Name Type Description
error String

Error message, if any.
data Key

The data returned by the service call.
response String

The complete HTTP response.

keyCreationCallback(error, data, response)

Callback function to receive the result of the keyCreation operation.

Parameters:
Name Type Description
error String

Error message, if any.
data KeyCreationResponse

The data returned by the service call.
response String

The complete HTTP response.

keySignDataCallback(error, data, response)

Callback function to receive the result of the keySignData operation.

Parameters:
Name Type Description
error String

Error message, if any.
data KeySignDataResponse

The data returned by the service call.
response String

The complete HTTP response.

KeyApi

new KeyApi(apiClientopt)

Constructs a new KeyApi.

Parameters:
Name Type Attributes Description
apiClient ApiClient <optional>

Optional API client implementation to use, default to ApiClient#instance if unspecified.

Methods

getKey(xChainId, keyId, callback)

GetKey Find key info

Parameters:
Name Type Description
xChainId String

Klaytn chain network ID (1001 or 8217)
keyId String
callback KeyApi~getKeyCallback

The callback function, accepting three arguments: error, data, response data is of type: Key

keyCreation(xChainId, opts, callback)

KeyCreation You can create key up to 100

Parameters:
Name Type Description
xChainId String

Klaytn chain network ID (1001 or 8217)
opts Object

Optional parameters

Properties
Name Type Description
body KeyCreationRequest
callback KeyApi~keyCreationCallback

The callback function, accepting three arguments: error, data, response data is of type: KeyCreationResponse

keySignData(xChainId, keyId, opts, callback)

KeySignData Sign the data using key

Parameters:
Name Type Description
xChainId String

Klaytn chain network ID (1001 or 8217)
keyId String
opts Object

Optional parameters

Properties
Name Type Description
xKrn String
body KeySignDataRequest
callback KeyApi~keySignDataCallback

The callback function, accepting three arguments: error, data, response data is of type: KeySignDataResponse

Type Definitions

getKeyCallback(error, data, response)

Callback function to receive the result of the getKey operation.

Parameters:
Name Type Description
error String

Error message, if any.
data Key

The data returned by the service call.
response String

The complete HTTP response.

keyCreationCallback(error, data, response)

Callback function to receive the result of the keyCreation operation.

Parameters:
Name Type Description
error String

Error message, if any.
data KeyCreationResponse

The data returned by the service call.
response String

The complete HTTP response.

keySignDataCallback(error, data, response)

Callback function to receive the result of the keySignData operation.

Parameters:
Name Type Description
error String

Error message, if any.
data KeySignDataResponse

The data returned by the service call.
response String

The complete HTTP response.