rekord-sdk 1.0.7

Trust Layer API

rekord_sdk

API documentation for Trust Layer front-facing endpoints (Catalogs, Versions, Proofs).

This Python package is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.6
• Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/Rekord-io/trust-layer.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/Rekord-io/trust-layer.git)

Then import the package:

import rekord_sdk

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import rekord_sdk

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import rekord_sdk
from rekord_sdk.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = rekord_sdk.CatalogApi(rekord_sdk.ApiClient(configuration))
catalog_id = 'catalog_id_example' # str | Catalog ID
version_id = 'version_id_example' # str | Optional Version ID linked to the catalog (optional)
multichain = NULL # object | Optional. When true, returns an alternate response format with additional anchor metadata. (optional)

try:
    # Get catalog blockchain proof
    api_response = api_instance.catalog_catalog_id_proof_get(catalog_id, version_id=version_id, multichain=multichain)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CatalogApi->catalog_catalog_id_proof_get: %s\n" % e)


# create an instance of the API class
api_instance = rekord_sdk.CatalogApi(rekord_sdk.ApiClient(configuration))
catalog_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | Catalog ID to update
body = rekord_sdk.CatalogIdUpdateBody() # CatalogIdUpdateBody |  (optional)
multichain = NULL # object | Optional. When true, returns an alternate response format.  Note: this flag only affects the response shape; it does not change how `blockchain` / `blockchains` are interpreted. (optional)

try:
    # Update catalog
    api_response = api_instance.catalog_catalog_id_update_post(catalog_id, body=body, multichain=multichain)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CatalogApi->catalog_catalog_id_update_post: %s\n" % e)


# create an instance of the API class
api_instance = rekord_sdk.CatalogApi(rekord_sdk.ApiClient(configuration))
catalog_id = 'catalog_id_example' # str |

try:
    # List catalog versions
    api_response = api_instance.catalog_catalog_id_versions_get(catalog_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CatalogApi->catalog_catalog_id_versions_get: %s\n" % e)


# create an instance of the API class
api_instance = rekord_sdk.CatalogApi(rekord_sdk.ApiClient(configuration))
body = rekord_sdk.CatalogCreateBody() # CatalogCreateBody |
multichain = NULL # object | Optional. When true, returns an alternate response format.  Note: this flag only affects the response shape; it does not change how `blockchain` / `blockchains` are interpreted. (optional)

try:
    # Create catalog
    api_response = api_instance.catalog_create_post(body, multichain=multichain)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CatalogApi->catalog_create_post: %s\n" % e)


# create an instance of the API class
api_instance = rekord_sdk.CatalogApi(rekord_sdk.ApiClient(configuration))
page = 1 # float | Page number (1-indexed). Defaults to 1 when omitted. (optional) (default to 1)
limit = 10 # float | Number of results per page (max 50). Defaults to 10. (optional) (default to 10)

try:
    # List catalogs
    api_response = api_instance.catalog_list_get(page=page, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CatalogApi->catalog_list_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api-dev.rekord.io

Class	Method	HTTP request	Description
CatalogApi	catalog_catalog_id_proof_get	GET /catalog/{catalogId}/proof	Get catalog blockchain proof
CatalogApi	catalog_catalog_id_update_post	POST /catalog/{catalogId}/update	Update catalog
CatalogApi	catalog_catalog_id_versions_get	GET /catalog/{catalogId}/versions	List catalog versions
CatalogApi	catalog_create_post	POST /catalog/create	Create catalog
CatalogApi	catalog_list_get	GET /catalog/list	List catalogs
JobsApi	jobs_job_id_get	GET /jobs/{jobId}	Get Job details. Including Status and other attached information. Note: the create callback mainly includes status updates. This is for full details.
ProofApi	proof_proof_id_get	GET /proof/{proofId}	Get proof details
UtilitiesApi	docs_json_get	GET /docs/json	Get OpenAPI schema
UtilitiesApi	health_get	GET /health	Health check
UtilitiesApi	utilities_chains_get	GET /utilities/chains	List supported blockchains
VersionApi	version_version_id_get	GET /version/{versionId}	Get version details
VersionApi	version_version_id_proof_get	GET /version/{versionId}/proof	Get version proof
VersionApi	version_version_id_verify_post	POST /version/{versionId}/verify	Verify Version membership

Documentation For Models

• AnyOfinlineResponse20010ServicesBody
• AnyOfinlineResponse503ServicesBody
• CatalogCreateBody
• CatalogIdUpdateBody
• CatalogcatalogIdupdateNewProofs
• CatalogcatalogIdupdateProofsRemoveBy
• CatalogcreateProofs
• InlineResponse200
• InlineResponse2001
• InlineResponse20010
• InlineResponse20010Services
• InlineResponse20011
• InlineResponse20011Data
• InlineResponse20011DataBlockchainProgress
• InlineResponse20011DataTimestamps
• InlineResponse20011DataVersion
• InlineResponse20011DataWebhook
• InlineResponse2001Data
• InlineResponse2001DataCatalogs
• InlineResponse2001DataCount
• InlineResponse2002
• InlineResponse2002Data
• InlineResponse2002DataVersion
• InlineResponse2002DataVersionAnchors
• InlineResponse2002DataVersionVerification
• InlineResponse2003
• InlineResponse2003Data
• InlineResponse2003DataFiles
• InlineResponse2004
• InlineResponse2005
• InlineResponse2005Data
• InlineResponse2006
• InlineResponse2006Data
• InlineResponse2006DataCatalog
• InlineResponse2006DataVersions
• InlineResponse2006DataVersionsItems
• InlineResponse2007
• InlineResponse2007Data
• InlineResponse2008
• InlineResponse2008Data
• InlineResponse2008DataProof
• InlineResponse2008DataStorage
• InlineResponse2009
• InlineResponse2009Info
• InlineResponse2009Servers
• InlineResponse200Data
• InlineResponse200DataJobs
• InlineResponse201
• InlineResponse2011
• InlineResponse2011Data
• InlineResponse201Data
• InlineResponse201DataJobs
• InlineResponse201DataPendingVersion
• InlineResponse201PendingVersion
• InlineResponse400
• InlineResponse4001
• InlineResponse4002
• InlineResponse4003
• InlineResponse4004
• InlineResponse4005
• InlineResponse4006
• InlineResponse4007
• InlineResponse4008
• InlineResponse401
• InlineResponse4011
• InlineResponse403
• InlineResponse4031
• InlineResponse404
• InlineResponse4041
• InlineResponse4042
• InlineResponse500
• InlineResponse5001
• InlineResponse5002
• InlineResponse5003
• InlineResponse5004
• InlineResponse5005
• InlineResponse5006
• InlineResponse5007
• InlineResponse5008
• InlineResponse5009
• InlineResponse503
• InlineResponse503Services
• OneOfinlineResponse2004Data
• OneOfinlineResponse2007DataVersion
• VersionIdVerifyBody
• VersionIdVerifyBody1

Documentation For Authorization

bearerAuth

Author