REST API

You can access the Rest API through the Swagger UI from the App API section. Navigate to Network -> Deployed Apps -> App -> Rest API

base url: 

https://<membership_id>.spydra.app/fabric/<app_id>

Get the base URL from Network -> Deployed Apps -> App -> Rest API page.
Select your organization at the top right of this page.

Alternatively, you can from the URL by getting the <membership_id> by navigating
to Network -> Members page and getting the <app_id> by navigating to the Network -> 
Deployed Apps -> App Overview page.

Create a transaction on the blockchain

POSThttps://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/ledger/transact

Authorization

api_key

Query parameters

Body

application/json

functionNamestring

argsarray of object

Response

200500

Transaction created

Body

application/json

one of

CreateTransactionResponseSync (object)CreateTransactionResponseAsync (object)

Request

JavaScriptCurl

const response = await fetch('https://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/ledger/transact', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "transactionId": "dd7817b56429532ceea32e2111faa20a7af87c945e7d8163ae2384c560b565f2",
  "receiptId": "643d316fa27b8c7dcdb31c49"
}

Queries/Evaluate the transaction on the blockchain

POSThttps://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/ledger/query

Authorization

api_key

Body

application/json

functionNamestring

argsarray of object

Response

200500

Transaction queried

Body

application/json

IDstring

Colorstring

Sizenumber

Ownerstring

AppraisedValuenumber

Request

JavaScriptCurl

const response = await fetch('https://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/ledger/query', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

[
  {
    "ID": "asset1",
    "Color": "whte",
    "Size": 15,
    "Owner": "Brad",
    "AppraisedValue": 200
  }
]

Issues the identity from the certificate authority

POSThttps://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/identity

Authorization

api_key

Body

application/json

enrollmentIdstring

typestring

maxEnrollmentsnumber

attributesobject

Response

201400500

Identity issued

Body

application/json

keystring

certificatestring

rootCertificatestring

Request

JavaScriptCurl

const response = await fetch('https://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/identity', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "key": "-----BEGIN PRIVATE KEY-----\r\nMIGHAgEAMBM-\n----END PRIVATE KEY-----\r\n",
  "certificate": "-----BEGIN CERTIFICATE-----\nMIICjDCCAjKgA\n-----END CERTIFICATE-----\n",
  "rootCertificate": "-----BEGIN CERTIFICATE-----\nMIICjDCCAjKgA\n-----END CERTIFICATE-----\n"
}

ReIssue the identity from the certificate authority

PATCHhttps://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/identity/{enrollmentId}

Authorization

api_key

Path parameters

enrollmentId*string

Response

201400404500

Identity reissued

Body

application/json

keystring

certificatestring

rootCertificatestring

Request

JavaScriptCurl

const response = await fetch('https://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/identity/{enrollmentId}', {
    method: 'PATCH',
    headers: {},
});
const data = await response.json();

Response

{
  "key": "-----BEGIN PRIVATE KEY-----\r\nMIGHAgEAMBM-\n----END PRIVATE KEY-----\r\n",
  "certificate": "-----BEGIN CERTIFICATE-----\nMIICjDCCAjKgA\n-----END CERTIFICATE-----\n",
  "rootCertificate": "-----BEGIN CERTIFICATE-----\nMIICjDCCAjKgA\n-----END CERTIFICATE-----\n"
}

Get the identity from the fabric certificate authority

GEThttps://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/identity/{enrollmentId}

Authorization

api_key

Path parameters

enrollmentId*string

Response

200404500

Fetched Identity

Body

application/json

idstring

typestring

affiliationstring

attrsarray of object

max_enrollmentsnumber

canamestring

Request

JavaScriptCurl

const response = await fetch('https://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/identity/{enrollmentId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "user1",
  "type": "client",
  "affiliation": "text",
  "attrs": [
    {
      "name": "user1",
      "value": "123",
      "ecert": true
    }
  ],
  "max_enrollments": 10,
  "caname": "ca-org1"
}

Revoke the identity from the certificate authority

DELETEhttps://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/identity/{enrollmentId}

Authorization

api_key

Path parameters

enrollmentId*string

Body

application/json

reasonstring

generateCRLboolean

Response

202404500

Identity revoked

Body

application/json

revokeUserobject

generatedCRLstring

Request

JavaScriptCurl

const response = await fetch('https://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/identity/{enrollmentId}', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "revokeUser": {
    "RevokedCerts": [
      {
        "Serial": "3bf5b6",
        "AKI": "3bf5b6"
      }
    ],
    "CRL": "text"
  },
  "generatedCRL": "LS0tLS1CRUd"
}

Get all identities from the certificate authority

GEThttps://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/identity/all

Authorization

api_key

Response

200500

Identities

Body

application/json

idstring

typestring

affiliationstring

attrsarray of object

max_enrollmentsnumber

canamestring

Request

JavaScriptCurl

const response = await fetch('https://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/identity/all', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": "user1",
    "type": "client",
    "affiliation": "text",
    "attrs": [
      {
        "name": "user1",
        "value": "123",
        "ecert": true
      }
    ],
    "max_enrollments": 10,
    "caname": "ca-org1"
  }
]

Get Fabric Chain Information

GEThttps://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/explorer/chainInfo

Authorization

api_key

Response

200500

ChainInfo

Body

application/json

heightstring

currentBlockHashstring

previousBlockHashstring

Request

JavaScriptCurl

const response = await fetch('https://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/explorer/chainInfo', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "height": "109",
  "currentBlockHash": "lXNu1mBUNpNAUzucy/2CAsk0Hq586+8WRO",
  "previousBlockHash": "Gob0PD5UgI38BwEQT+baD+8ei92WBbY"
}

Get Blockchan Block for a Number

GEThttps://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/explorer/block/byNumber/{blockNumber}

Authorization

api_key

Path parameters

blockNumber*number

Response

200400500

Block data

Body

application/json

headerobject

dataobject

metadataobject

Request

JavaScriptCurl

const response = await fetch('https://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/explorer/block/byNumber/{blockNumber}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "header": {
    "number": 10,
    "previous_hash": "\u0014����2�S�q\u001ck��h",
    "data_hash": "I\u0006(p�o\u0013"
  },
  "data": {
    "data": [
      {
        "signature": "I\u0006(p�o\u0014"
      }
    ]
  },
  "metadata": {
    "metadata": [
      {
        "value": "II\u0006(p�o\u0014345",
        "signatures": []
      }
    ]
  }
}

Get Blockchan Block for a TransactionId

GEThttps://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/explorer/block/byTxId/{transactionId}

Authorization

api_key

Path parameters

transactionId*string

Response

200500

Block data

Body

application/json

headerobject

dataobject

metadataobject

Request

JavaScriptCurl

const response = await fetch('https://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/explorer/block/byTxId/{transactionId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "header": {
    "number": 10,
    "previous_hash": "\u0014����2�S�q\u001ck��h",
    "data_hash": "I\u0006(p�o\u0013"
  },
  "data": {
    "data": [
      {
        "signature": "I\u0006(p�o\u0014"
      }
    ]
  },
  "metadata": {
    "metadata": [
      {
        "value": "II\u0006(p�o\u0014345",
        "signatures": []
      }
    ]
  }
}

Get Blockchan Transaction for a TransactionId

GEThttps://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/explorer/transaction/byTxId/{transactionId}

Authorization

api_key

Path parameters

transactionId*string

Response

200500

Transaction data

Body

application/json

validationCodenumber

dataTransactionResponse (object)

transaction_hashstring

created_datestring

transaction_typestring

chaincode_namestring

block_numberobject

msp_idstring

Request

JavaScriptCurl

const response = await fetch('https://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/explorer/transaction/byTxId/{transactionId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "validationCode": 0,
  "data": {
    "signature": "I\u0006(p�o\u0014",
    "payload": {}
  },
  "transaction_hash": "dd81d0c67b75fe16c30fa113e1b3ef020cb9e92",
  "created_date": "2023-05-16T11:39:46.499Z",
  "transaction_type": "ENDORSER_TRANSACTION",
  "chaincode_name": "document-contract",
  "block_number": {
    "low": 50,
    "high": 0,
    "unsigned": true
  },
  "msp_id": "Org1"
}

Get latest Blocks

GEThttps://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/explorer/block/latest

Authorization

api_key

Query parameters

Response

200400500

Block data

Body

application/json

recordsarray of BlockResponse (object)

bookmarknumber

countnumber

Request

JavaScriptCurl

const response = await fetch('https://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/explorer/block/latest', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "records": [
    {
      "header": {
        "number": 10,
        "previous_hash": "\u0014����2�S�q\u001ck��h",
        "data_hash": "I\u0006(p�o\u0013"
      },
      "data": {
        "data": [
          {
            "signature": "I\u0006(p�o\u0014"
          }
        ]
      },
      "metadata": {
        "metadata": [
          {
            "value": "II\u0006(p�o\u0014345",
            "signatures": []
          }
        ]
      }
    }
  ],
  "bookmark": 8,
  "count": 2
}

Get latest Transactions

GEThttps://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/explorer/transaction/latest

Authorization

api_key

Query parameters

Response

200400500

Transaction data

Body

application/json

recordsarray of object

bookmarkstring

countnumber

nextTransactionsExistboolean

Request

JavaScriptCurl

const response = await fetch('https://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/explorer/transaction/latest', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "records": [
    {
      "block_number": 8,
      "data": {
        "signature": "I\u0006(p�o\u0014",
        "payload": {}
      },
      "transaction_hash": "dd81d0c67b75fe16c30fa113e1b3ef020cb9e92",
      "created_date": "2023-05-16T11:39:46.499Z",
      "transaction_type": "ENDORSER_TRANSACTION",
      "chaincode_name": "document-contract",
      "msp_id": "Org1"
    }
  ],
  "bookmark": "99_dd81d0c67b75fe16c30fa113e1b3ef020cb9e",
  "count": 2,
  "nextTransactionsExist": false
}

Get the status of an already submitted transaction using the returned receipt id.

GEThttps://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/receipt

Authorization

api_key

Query parameters

Response

200400500

Transaction found.

Body

application/json

transactionIdstring

The ledger transaction Id corresponding to the receipt id.

statusenum

The status of the submitted transaction.

COMMITTEDFAILEDINITIATED

messagestring

Error message when the transaction status is FAILED.

Request

JavaScriptCurl

const response = await fetch('https://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/receipt', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "transactionId": "6c94ff55155722c28611630e7d6795145e0282e9fabf10bf3460f396e2a6218b",
  "status": "COMMITTED",
  "message": "Success"
}