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.

PreviousCustom Chaincode NextTesting REST API

Last updated 1 year ago

Was this helpful?

Create a transaction on the blockchain

post

/ledger/transact

Authorizations

Query parameters

asyncstring

Whether to wait for the transaction to be created before returning a response or not. When async=false (default), the API will wait for the transaction to be committed on the Ledger and then return the transaction Id. If async=true, the API will return immediately with a receipt Id. The reciept Id can be used to check the status of the transaction anytime using the /receipt endpoint.

Body

functionNamestring

Example: CreateDocumentDefinitions

argsobject[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/ledger/transact' \
  --header 'X-API-KEY: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"functionName":"CreateDocumentDefinitions","args":[{"id":"Invoice","name":"Invoice","idAttribute":"id"}]}'

200

500

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

Transaction created

Queries/Evaluate the transaction on the blockchain

post

/ledger/query

Authorizations

Body

functionNamestring

Example: CreateDocumentDefinitions

argsobject[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/ledger/query' \
  --header 'X-API-KEY: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"functionName":"CreateDocumentDefinitions","args":[{"id":"Invoice","name":"Invoice","idAttribute":"id"}]}'

200

500

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

Transaction queried

Issues the identity from the certificate authority

post

/identity

Authorizations

Body

enrollmentIdstring

Example: user1

typestring

Example: client

maxEnrollmentsnumber

Example: 10

attributesobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/identity' \
  --header 'X-API-KEY: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"enrollmentId":"user1","type":"client","maxEnrollments":10,"attributes":{"userEmail":"user1@email.com"}}'

201

400

500

{
  "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"
}

Identity issued

ReIssue the identity from the certificate authority

patch

/identity/{enrollmentId}

Authorizations

Path parameters

enrollmentIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/identity/{enrollmentId}' \
  --header 'X-API-KEY: YOUR_API_KEY'

201

400

404

500

{
  "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"
}

Identity reissued

Get the identity from the fabric certificate authority

get

/identity/{enrollmentId}

Authorizations

Path parameters

enrollmentIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/identity/{enrollmentId}' \
  --header 'X-API-KEY: YOUR_API_KEY'

200

404

500

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

Fetched Identity

Revoke the identity from the certificate authority

delete

/identity/{enrollmentId}

Authorizations

Path parameters

enrollmentIdstringrequired

Body

reasonstring

Example: keycompromise

generateCRLboolean

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/identity/{enrollmentId}' \
  --header 'X-API-KEY: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"reason":"keycompromise"}'

202

404

500

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

Identity revoked

Get all identities from the certificate authority

get

/identity/all

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/identity/all' \
  --header 'X-API-KEY: YOUR_API_KEY'

200

500

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

Identities

Get Fabric Chain Information

get

/explorer/chainInfo

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/explorer/chainInfo' \
  --header 'X-API-KEY: YOUR_API_KEY'

200

500

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

ChainInfo

Get Blockchan Block for a Number

get

/explorer/block/byNumber/{blockNumber}

Authorizations

Path parameters

blockNumbernumberrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/explorer/block/byNumber/{blockNumber}' \
  --header 'X-API-KEY: YOUR_API_KEY'

200

400

500

{
  "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",
        "payload": {}
      }
    ]
  },
  "metadata": {
    "metadata": [
      {
        "value": "II\u0006(p�o\u0014345",
        "signatures": [
          {}
        ]
      }
    ]
  }
}

Block data

Get Blockchan Block for a TransactionId

get

/explorer/block/byTxId/{transactionId}

Authorizations

Path parameters

transactionIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/explorer/block/byTxId/{transactionId}' \
  --header 'X-API-KEY: YOUR_API_KEY'

200

500

{
  "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",
        "payload": {}
      }
    ]
  },
  "metadata": {
    "metadata": [
      {
        "value": "II\u0006(p�o\u0014345",
        "signatures": [
          {}
        ]
      }
    ]
  }
}

Block data

Get Blockchan Transaction for a TransactionId

get

/explorer/transaction/byTxId/{transactionId}

Authorizations

Path parameters

transactionIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/explorer/transaction/byTxId/{transactionId}' \
  --header 'X-API-KEY: YOUR_API_KEY'

200

500

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

Transaction data

Get latest Blocks

get

/explorer/block/latest

Authorizations

Query parameters

limitstring

bookmarkstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/explorer/block/latest' \
  --header 'X-API-KEY: YOUR_API_KEY'

200

400

500

{
  "bookmark": 8,
  "count": 2,
  "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",
            "payload": {}
          }
        ]
      },
      "metadata": {
        "metadata": [
          {
            "value": "II\u0006(p�o\u0014345",
            "signatures": [
              {}
            ]
          }
        ]
      }
    }
  ]
}

Block data

Get latest Transactions

get

/explorer/transaction/latest

Authorizations

Query parameters

limitstring

bookmarkstring

block_numberstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/explorer/transaction/latest' \
  --header 'X-API-KEY: YOUR_API_KEY'

200

400

500

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

Transaction data

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

get

/receipt

Authorizations

Query parameters

receiptIdstringrequired

The receipt id returned while submitting the transaction.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://<networkorgid>.<publicdomain>/fabric/<chaincodeccid>/receipt?receiptId=text' \
  --header 'X-API-KEY: YOUR_API_KEY'

200

400

500

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

Transaction found.