Skip to main content

Trust Layer API

Project description

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: v0.7.7
  • Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

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

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

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.AnalyticsApi(rekord_sdk.ApiClient(configuration))
organization_id = 'organization_id_example' # str | Optional organization ID (required for multi-org users). (optional)

try:
    # Company KPIs (catalogs, proofs, transactions)
    api_response = api_instance.kpis_get(organization_id=organization_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnalyticsApi->kpis_get: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
AnalyticsApi kpis_get GET /kpis Company KPIs (catalogs, proofs, transactions)
CatalogApi catalog_bulk_create_post POST /catalog/bulk/create Bulk create catalogs
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_batch_batch_id_get GET /jobs/batch/{batchId} Get Batch progress by batchId
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
UsersApi organizations_org_id_users_user_id_delete DELETE /organizations/{orgId}/users/{userId}
UsersApi users_get GET /users
UsersApi users_invitations_get GET /users/invitations
UsersApi users_invitations_invitation_id_delete DELETE /users/invitations/{invitationId}
UsersApi users_invitations_invitation_id_patch PATCH /users/invitations/{invitationId}
UsersApi users_invitations_invitation_id_resend_post POST /users/invitations/{invitationId}/resend
UsersApi users_invite_accept_post POST /users/invite/accept
UsersApi users_invite_post POST /users/invite
UsersApi users_user_id_delete DELETE /users/{userId}
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 Authorization

bearerAuth

Author

Project details


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-0.7.7.tar.gz (65.0 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-0.7.7-py3-none-any.whl (267.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rekord_sdk-0.7.7.tar.gz
  • Upload date:
  • Size: 65.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for rekord_sdk-0.7.7.tar.gz
Algorithm Hash digest
SHA256 197e75f352db8366cafea7b5d0b1e71fc1944f999a4b37bc4f3a77dead54f822
MD5 ac9cfdf24ad5eb19cdb778707d389d59
BLAKE2b-256 23458f356fe04bddb79c035aa1716b42013043b92453ff80af298eed74b575d0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rekord_sdk-0.7.7-py3-none-any.whl
  • Upload date:
  • Size: 267.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for rekord_sdk-0.7.7-py3-none-any.whl
Algorithm Hash digest
SHA256 e454d87e7162f3f08c7cd0bb059b5107a2ec48b960155d0a4ae4de831f9b59d4
MD5 c2faaa9be6413202577a510d80ef9659
BLAKE2b-256 1528e7d57b2f2a8a62849799fb43eaf5ee366ec46078b6fad6b9626403003e03

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