Trust Layer API

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for vibhavk7 from gravatar.com vibhavk7

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers
Report project as malware

Project description

rekord-io-sdk

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

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import rekord_sdk
from rekord_sdk.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 = rekord_sdk.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 = rekord_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with rekord_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = rekord_sdk.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

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

  • Type: Bearer authentication (JWT)

Author

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for vibhavk7 from gravatar.com vibhavk7

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Release history Release notifications | RSS feed

1.0.20

1.0.19

1.0.18

1.0.17

1.0.16

1.0.15

1.0.14

1.0.13

1.0.12

1.0.11

1.0.10

1.0.9

1.0.8

1.0.7

1.0.6

This version

1.0.5

0.7.7

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rekord_sdk-1.0.5.tar.gz (86.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rekord_sdk-1.0.5-py3-none-any.whl (223.2 kB view details)

Uploaded Python 3

File details

Details for the file rekord_sdk-1.0.5.tar.gz.

File metadata

  • Download URL: rekord_sdk-1.0.5.tar.gz
  • Upload date:
  • Size: 86.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.12.3 Linux/6.6.87.2-microsoft-standard-WSL2

File hashes

Hashes for rekord_sdk-1.0.5.tar.gz
Algorithm Hash digest
SHA256 23a37132d27d923eb6f1e149b8c81174f2974d76694ff7e82acafa4108d962d1
MD5 9b0448caf70ef7d3041d2709dbc11217
BLAKE2b-256 462050218b0098cc100aa37d5510a329c3d96597a251d6da233625973d3284b7

See more details on using hashes here.

File details

Details for the file rekord_sdk-1.0.5-py3-none-any.whl.

File metadata

  • Download URL: rekord_sdk-1.0.5-py3-none-any.whl
  • Upload date:
  • Size: 223.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.12.3 Linux/6.6.87.2-microsoft-standard-WSL2

File hashes

Hashes for rekord_sdk-1.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 a112d89dd8348c36b5cae5cd98681d9271b98bd2a9e0d16d2612f27bdf734aeb
MD5 ba3a842b30061da7fee38145863619fc
BLAKE2b-256 7e5951ab27d98e0b8d00a522edce2e808dac361a50b01e0ea7f5bacbff714d6a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page