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: 1.0.19
- 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_bulk_delete_post | POST /catalog/bulk/delete | Bulk delete catalogs |
| CatalogApi | catalog_bulk_update_post | POST /catalog/bulk/update | Bulk update catalogs |
| CatalogApi | catalog_catalog_id_delete_post | POST /catalog/{catalogId}/delete | Delete catalog |
| 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_delete_post | POST /catalog/delete | Delete catalog (body) |
| CatalogApi | catalog_list_get | GET /catalog/list | List catalogs |
| CatalogTypeApi | catalog_type_assign_post | POST /catalog-type/assign | Assign catalog type to catalog |
| CatalogTypeApi | catalog_type_bulk_assign_post | POST /catalog-type/bulk-assign | Bulk assign catalog type to catalogs |
| CatalogTypeApi | catalog_type_bulk_delete_post | POST /catalog-type/bulk-delete | Bulk delete catalog types |
| CatalogTypeApi | catalog_type_catalog_type_id_delete | DELETE /catalog-type/{catalog_type_id} | Delete catalog type |
| CatalogTypeApi | catalog_type_catalog_type_id_get | GET /catalog-type/{catalog_type_id} | Get catalog type |
| CatalogTypeApi | catalog_type_catalog_type_id_update_put | PUT /catalog-type/{catalog_type_id}/update | Update catalog type |
| CatalogTypeApi | catalog_type_create_post | POST /catalog-type/create | Create catalog type |
| CatalogTypeApi | catalog_type_list_get | GET /catalog-type/list | List catalog types |
| 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. |
| OrganizationApplicationsApi | organizations_org_id_applications_client_id_delete | DELETE /organizations/{orgId}/applications/{clientId} | |
| OrganizationApplicationsApi | organizations_org_id_applications_get | GET /organizations/{orgId}/applications | |
| OrganizationApplicationsApi | organizations_org_id_applications_put | PUT /organizations/{orgId}/applications | |
| OrganizationsApi | organizations_get | GET /organizations | |
| OrganizationsApi | organizations_id_get | GET /organizations/{id} | |
| OrganizationsApi | organizations_post | POST /organizations | |
| PoolApi | pool_bulk_delete_post | POST /pool/bulk-delete | Bulk delete pools |
| PoolApi | pool_create_post | POST /pool/create | Create pool |
| PoolApi | pool_currencies_get | GET /pool/currencies | List currencies for autocomplete |
| PoolApi | pool_list_get | GET /pool/list | List pools |
| PoolApi | pool_pool_id_catalogs_add_post | POST /pool/{pool_id}/catalogs/add | Add catalogs to pool |
| PoolApi | pool_pool_id_catalogs_remove_post | POST /pool/{pool_id}/catalogs/remove | Remove catalogs from pool |
| PoolApi | pool_pool_id_delete_post | POST /pool/{pool_id}/delete | Delete pool |
| PoolApi | pool_pool_id_get | GET /pool/{pool_id} | Get pool |
| PoolApi | pool_pool_id_latest_proofs_get | GET /pool/{pool_id}/latest-proofs | Get latest proofs across pool catalogs |
| PoolApi | pool_pool_id_update_put | PUT /pool/{pool_id}/update | Update pool |
| PoolApi | pool_pool_id_widget_data_get | GET /pool/{pool_id}/widget-data | Get pool widget data |
| PoolApi | pool_pool_id_widget_data_refresh_post | POST /pool/{pool_id}/widget-data/refresh | Refresh pool widget data |
| PoolApi | pool_tags_get | GET /pool/tags | List tags for autocomplete |
| PoolApi | pool_widgets_available_post | POST /pool/widgets/available | Derive available widgets |
| PoolApi | pool_widgets_get | GET /pool/widgets | List widget config |
| 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_me_invitations_get | GET /users/me/invitations | |
| 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file rekord_sdk-1.0.19.tar.gz.
File metadata
- Download URL: rekord_sdk-1.0.19.tar.gz
- Upload date:
- Size: 92.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a5d6688e0aaad17b8910a936803869f98651d8d5f20dc1a535d7f3ddf81b55c3
|
|
| MD5 |
1d7670e6999b89e97055a9592fc85fbb
|
|
| BLAKE2b-256 |
39142c2be9e899735a89be4fbd9d8561ab55d7a41095dc89f38c1fdb45ea6c11
|
File details
Details for the file rekord_sdk-1.0.19-py3-none-any.whl.
File metadata
- Download URL: rekord_sdk-1.0.19-py3-none-any.whl
- Upload date:
- Size: 389.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c48994497cdd5025d3d7e7a5d2396fd244a7785b7f17764b859156ae7a813e8a
|
|
| MD5 |
171ae679c5b838ecc3849d38ebd57871
|
|
| BLAKE2b-256 |
2a6aaa37da18b384fc19647b202cd40cb71ec902e698496ed38a94489b2190ee
|