Skip to content

BackendApi.md

Latest commit

 

History

History
277 lines (189 loc) · 7.49 KB

BackendApi.md

File metadata and controls

277 lines (189 loc) · 7.49 KB

EasyBlockchainApi.BackendApi

All URIs are relative to https://gw.api.cloud.sphereon.com/blockchain/easy/0.10

Method HTTP request Description
createBackend POST /backends Create a new backend
deleteBackend DELETE /backends/{backendId} Delete a backend
findBackends GET /backends/{backendId}/find Find backends
getBackend GET /backends/{backendId} Get backend by id
listBackends GET /backends List backends

createBackend

Backend createBackend(backend)

Create a new backend

Create a new backend. A Backend is the link to one blockchain implementation and it' s nodes. Unless you create your own private blockchain network, you should not have to create a new backend. Just use one of the public backends available.

Example

var EasyBlockchainApi = require('easy_blockchain_api');
var defaultClient = EasyBlockchainApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EasyBlockchainApi.BackendApi();

var backend = new EasyBlockchainApi.Backend(); // Backend | backend


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.createBackend(backend, callback);

Parameters

Name Type Description Notes
backend Backend backend

Return type

Backend

Authorization

oauth2schema

HTTP request headers

  • Content-Type: application/json;charset=UTF-8
  • Accept: application/json;charset=UTF-8

deleteBackend

Backend deleteBackend(backendId)

Delete a backend

Delete backend by id (not by name)

Example

var EasyBlockchainApi = require('easy_blockchain_api');
var defaultClient = EasyBlockchainApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EasyBlockchainApi.BackendApi();

var backendId = "backendId_example"; // String | backendId


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.deleteBackend(backendId, callback);

Parameters

Name Type Description Notes
backendId String backendId

Return type

Backend

Authorization

oauth2schema

HTTP request headers

  • Content-Type: application/json
  • Accept: /

findBackends

[Backend] findBackends(backendId, opts)

Find backends

Find existing backend(s) by id (single result) and/or name (multiple results). Optionally including public backends of others. Please note that we never return sensitive information like password or rpc hosts. Even not for backend owners themselves

Example

var EasyBlockchainApi = require('easy_blockchain_api');
var defaultClient = EasyBlockchainApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EasyBlockchainApi.BackendApi();

var backendId = "backendId_example"; // String | backendId

var opts = { 
  'includePublic': false // Boolean | includePublic
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.findBackends(backendId, opts, callback);

Parameters

Name Type Description Notes
backendId String backendId
includePublic Boolean includePublic [optional] [default to false]

Return type

[Backend]

Authorization

oauth2schema

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json;charset=UTF-8

getBackend

Backend getBackend(backendId, opts)

Get backend by id

Get existing backend by id (not by name). Optionally including public backend of others. Please note that we never return sensitive information like password or rpc hosts. Even not for backend owners themselves

Example

var EasyBlockchainApi = require('easy_blockchain_api');
var defaultClient = EasyBlockchainApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EasyBlockchainApi.BackendApi();

var backendId = "backendId_example"; // String | backendId

var opts = { 
  'includePublic': false // Boolean | includePublic
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getBackend(backendId, opts, callback);

Parameters

Name Type Description Notes
backendId String backendId
includePublic Boolean includePublic [optional] [default to false]

Return type

Backend

Authorization

oauth2schema

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json;charset=UTF-8

listBackends

[Backend] listBackends(opts)

List backends

List existing backends. Optionally including public backends of others. Please note that we never return sensitive information like password or rpc hosts. Even not for backend owners themselves

Example

var EasyBlockchainApi = require('easy_blockchain_api');
var defaultClient = EasyBlockchainApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EasyBlockchainApi.BackendApi();

var opts = { 
  'includePublic': false // Boolean | includePublic
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.listBackends(opts, callback);

Parameters

Name Type Description Notes
includePublic Boolean includePublic [optional] [default to false]

Return type

[Backend]

Authorization

oauth2schema

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json;charset=UTF-8