rekord-io-sdk 1.0.4

Rekord.io SDK

openapi-client

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

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.20.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import openapi_client

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 openapi_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api-dev.rekord.io
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "https://api-dev.rekord.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = openapi_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.CatalogApi(api_client)
    catalog_id = 'catalog_id_example' # str | Catalog ID
    version_id = 'version_id_example' # str | Optional Version ID linked to the catalog (optional)
    multichain = None # 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)
        print("The response of CatalogApi->catalog_catalog_id_proof_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CatalogApi->catalog_catalog_id_proof_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

• AlternateResponseDataWrapper
• AlternateResponseDataWrapper1
• AlternateResponseDataWrapper1Data
• AlternateResponseDataWrapper1DataJobsInner
• AlternateResponseDataWrapper2
• AlternateResponseDataWrapper2Data
• AlternateResponseDataWrapper3
• AlternateResponseDataWrapper3AnchorsInner
• AlternateResponseDataWrapper3Verification
• AlternateResponseDataWrapperData
• AlternateResponseDataWrapperDataJobsInner
• AlternateResponseDataWrapperDataPendingVersion
• AlternateResponseExtendedAnchorMetadata
• AlternateResponseExtendedAnchorMetadataAnchorsInner
• AlternateResponseExtendedAnchorMetadataVerification
• BYTESBASE64
• BYTESBASE641
• BYTESBASE642
• CatalogCatalogIdProofGet200Response
• CatalogCatalogIdProofGet200ResponseData
• CatalogCatalogIdProofGet200ResponseDataVersion
• CatalogCatalogIdProofGet200ResponseDataVersionAnchorsInner
• CatalogCatalogIdProofGet200ResponseDataVersionVerification
• CatalogCatalogIdProofGet400Response
• CatalogCatalogIdProofGet404Response
• CatalogCatalogIdProofGet500Response
• CatalogCatalogIdUpdatePost200Response
• CatalogCatalogIdUpdatePost201Response
• CatalogCatalogIdUpdatePost400Response
• CatalogCatalogIdUpdatePost500Response
• CatalogCatalogIdUpdatePostRequest
• CatalogCatalogIdUpdatePostRequestNewProofsInner
• CatalogCatalogIdUpdatePostRequestProofsRemoveByInner
• CatalogCatalogIdVersionsGet200Response
• CatalogCatalogIdVersionsGet200ResponseData
• CatalogCatalogIdVersionsGet200ResponseDataCatalog
• CatalogCatalogIdVersionsGet200ResponseDataVersions
• CatalogCatalogIdVersionsGet200ResponseDataVersionsItemsInner
• CatalogCatalogIdVersionsGet400Response
• CatalogCatalogIdVersionsGet500Response
• CatalogCreatePost201Response
• CatalogCreatePost400Response
• CatalogCreatePost401Response
• CatalogCreatePost403Response
• CatalogCreatePost500Response
• CatalogCreatePostRequest
• CatalogCreatePostRequestProofsInner
• CatalogListGet200Response
• CatalogListGet200ResponseData
• CatalogListGet200ResponseDataCatalogsInner
• CatalogListGet200ResponseDataCount
• CatalogListGet400Response
• CatalogListGet500Response
• DefaultResponseRecommended
• DefaultResponseRecommended1
• DefaultResponseRecommended2
• DefaultResponseRecommended3
• DefaultResponseRecommended4
• DefaultResponseRecommended4AnchorsInner
• DefaultResponseRecommended4CatalogOwner
• DefaultResponseRecommended4Components
• DefaultResponseRecommended4ComponentsItemsInner
• DefaultResponseRecommended4Proofs
• DefaultResponseRecommended4ProofsItemsInner
• DefaultResponseRecommended4Tree
• DefaultResponseRecommendedPendingVersion
• DocsJsonGet200Response
• DocsJsonGet200ResponseInfo
• DocsJsonGet200ResponseServersInner
• FILEREF
• FILEREF1
• HealthGet200Response
• HealthGet200ResponseServicesInner
• HealthGet200ResponseServicesInnerBody
• HealthGet503Response
• HealthGet503ResponseServicesInner
• HealthGet503ResponseServicesInnerBody
• JSON1
• JSON2
• JobsJobIdGet200Response
• JobsJobIdGet200ResponseOneOf
• JobsJobIdGet200ResponseOneOfData
• JobsJobIdGet200ResponseOneOfDataBlockchainProgress
• JobsJobIdGet200ResponseOneOfDataTimestamps
• JobsJobIdGet200ResponseOneOfDataVersion
• JobsJobIdGet200ResponseOneOfDataWebhook
• JobsJobIdGet400Response
• JobsJobIdGet401Response
• JobsJobIdGet403Response
• JobsJobIdGet404Response
• JobsJobIdGet500Response
• ModelJSON
• ProofProofIdGet200Response
• ProofProofIdGet200ResponseData
• ProofProofIdGet200ResponseDataProof
• ProofProofIdGet200ResponseDataStorage
• ProofProofIdGet400Response
• ProofProofIdGet404Response
• ProofProofIdGet500Response
• TEXT
• TEXT1
• TEXT2
• UtilitiesChainsGet200Response
• UtilitiesChainsGet200ResponseData
• VersionVersionIdGet200Response
• VersionVersionIdGet200ResponseData
• VersionVersionIdGet200ResponseDataVersion
• VersionVersionIdGet500Response
• VersionVersionIdProofGet200Response
• VersionVersionIdProofGet200ResponseData
• VersionVersionIdProofGet400Response
• VersionVersionIdProofGet500Response
• VersionVersionIdVerifyPost200Response
• VersionVersionIdVerifyPost200ResponseData
• VersionVersionIdVerifyPost200ResponseDataFilesInner
• VersionVersionIdVerifyPost400Response
• VersionVersionIdVerifyPost500Response
• VersionVersionIdVerifyPostRequest
• VersionVersionIdVerifyPostRequestAnyOf
• XML
• XML1
• XML2

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication (JWT)

Author