rekord-sdk 1.0.8

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.8
• 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

Friendly method names (conceptual) mapped to generated functions:

Action	Friendly name	Generated method
Get catalog proof	get_catalog_proof(catalog_id, version_id=None, multichain=None)	catalog_catalog_id_proof_get
Update catalog	update_catalog(catalog_id, catalog_data, multichain=None)	catalog_catalog_id_update_post
List catalog versions	list_catalog_versions(catalog_id)	catalog_catalog_id_versions_get
Create catalog	create_catalog(catalog_request, multichain=None)	catalog_create_post
List catalogs	list_catalogs(page=1, limit=10)	catalog_list_get
Get job	get_job(job_id)	jobs_job_id_get
Get proof	get_proof(proof_id)	proof_proof_id_get
Get OpenAPI schema	get_docs_json()	docs_json_get
Health check	get_health()	health_get
List chains	list_chains()	utilities_chains_get
Get version	get_version(version_id)	version_version_id_get
Get version proof	get_version_proof(version_id, multichain=None)	version_version_id_proof_get
Verify version	verify_version(version_id, body)	version_version_id_verify_post

Full generated docs (hosted in the repo):

• CatalogApi: https://github.com/Rekord-io/trust-layer/blob/main/rekord-io-sdk/docs/CatalogApi.md
• JobsApi: https://github.com/Rekord-io/trust-layer/blob/main/rekord-io-sdk/docs/JobsApi.md
• ProofApi: https://github.com/Rekord-io/trust-layer/blob/main/rekord-io-sdk/docs/ProofApi.md
• UtilitiesApi: https://github.com/Rekord-io/trust-layer/blob/main/rekord-io-sdk/docs/UtilitiesApi.md
• VersionApi: https://github.com/Rekord-io/trust-layer/blob/main/rekord-io-sdk/docs/VersionApi.md

Documentation For Authorization

bearerAuth

Author