tachain-sdk

Public integration endpoints. Set your own base URL and credential before calling.

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

• API version: 1.0.0
• Package version: 0.1.0
• Generator version: 7.25.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.10+

Installation & Usage

pip install

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

pip install git+https://github.com/ta-chain/tachain-sdk.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/ta-chain/tachain-sdk.git)

Then import the package:

import tachain_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 tachain_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import tachain_sdk
from tachain_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.example.com
# See configuration.py for a list of all supported configuration parameters.
configuration = tachain_sdk.Configuration(
    host = "https://api.example.com"
)

# 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 API key authorization: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Configure API key authorization: Signature
configuration.api_key['Signature'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Signature'] = 'Bearer'

# Configure Bearer authorization: BearerToken
configuration = tachain_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: Timestamp
configuration.api_key['Timestamp'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Timestamp'] = 'Bearer'


# Enter a context with an instance of the API client
with tachain_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = tachain_sdk.ApiDeclarationApi(api_client)
    x_credential_type = 'x_credential_type_example' # str | Use 'Token' with bearer authorization, or 'API Key' with signed API key headers. This header is mandatory in the deployed API.
    attachment_id = 'attachment_id_example' # str | query 方式传入的单个附件申报 ID。 (optional)
    form_data_id = 'form_data_id_example' # str | query 方式传入的单个表单申报 ID。 (optional)
    tactic_chain_api_service_controllers_api_integration_v1_api_declaration_delete_request = tachain_sdk.TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationDeleteRequest() # TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationDeleteRequest |  (optional)

    try:
        # 申报信息删除接口。
        api_response = api_instance.delete_v1_declaration_delete(x_credential_type, attachment_id=attachment_id, form_data_id=form_data_id, tactic_chain_api_service_controllers_api_integration_v1_api_declaration_delete_request=tactic_chain_api_service_controllers_api_integration_v1_api_declaration_delete_request)
        print("The response of ApiDeclarationApi->delete_v1_declaration_delete:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ApiDeclarationApi->delete_v1_declaration_delete: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.example.com

Documentation For Models

• GetV1EnumGetList200Response
• MicrosoftAspNetCoreMvcProblemDetails
• Model1
• Model3
• Model4
• TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationDeleteRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationDocumentRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationListDto
• TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationSubmitRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationSubmitResultDto
• TacticChainApiServiceControllersApiIntegrationV1ApiIntegrationDeleteRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiOrderConfirmReceiptRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiOrderSubmitAuditRequest
• TacticChainApiServiceDataEntitiesCompany
• TacticChainApiServiceDataEntitiesCompanyComplianceProfile
• TacticChainApiServiceDataEntitiesCompanyUtilityDeclaration
• TacticChainApiServiceDataEntitiesCustomer
• TacticChainApiServiceDataEntitiesFactory
• TacticChainApiServiceDataEntitiesOrder
• TacticChainApiServiceDataEntitiesOrderLine
• TacticChainApiServiceDataEntitiesSupplier
• TacticChainApiServiceDataEntitiesSupplierOnboardingExt
• TacticChainApiServiceDataEntitiesTrader
• TacticChainApiServiceHelperResultApiEnum
• TacticChainApiServiceHelperResultBrandReportAllocatedDeliveryKpiDetail
• TacticChainApiServiceHelperResultBrandReportUnlinkedOrderDetail
• TacticChainApiServiceHelperResultKpiArchivedDataChangeDetail
• TacticChainApiServiceHelperResultMappingOrderSelect
• TacticChainApiServiceHelperResultOrderTraceReport
• TacticChainApiServiceHelperTemplateDtoBusinessRiskWarnInfoDto
• TacticChainApiServiceHelperTemplateDtoMultiSoLineCompleteStatus
• TacticChainApiServiceModelsBrandKpiPolicyResult
• TacticChainApiServiceModelsBrandOrderKpiSnapshotDto
• TacticChainApiServiceModelsBrandOrderSupplierOrderSnapshotDto
• TacticChainApiServiceModelsBrandOrderUncompletedDeclareSnapshotDto
• TacticChainApiServiceModelsOrderStageFormDto
• TacticChainApiServiceModelsProductBomGroupingDto
• TacticChainApiServiceModelsProductionRawMaterialDto
• TacticChainApiServiceViewModelsAttachmentInApiCreateDto
• TacticChainApiServiceViewModelsAttachmentInApiDto
• TacticChainApiServiceViewModelsCommonApiResponse1SystemStringSystemPrivateCoreLibVersion9000CultureNeutralPublicKeyToken7cec85d7bea7798e
• TacticChainApiServiceViewModelsCommonApiResponse1TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationListDtoTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull
• TacticChainApiServiceViewModelsCommonApiResponse1TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationSubmitResultDtoTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull
• TacticChainApiServiceViewModelsCommonApiResponse1TacticChainApiServiceViewModelsDeliveryNoteApiDtoTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull
• TacticChainApiServiceViewModelsCommonApiResponse1TacticChainApiServiceViewModelsOrderApiDtoTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull
• TacticChainApiServiceViewModelsCommonApiResponse1TacticChainApiServiceViewModelsProductionApiDtoTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull
• TacticChainApiServiceViewModelsCommonPagedResponse1TacticChainApiServiceViewModelsDeliveryNoteApiDtoTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull
• TacticChainApiServiceViewModelsCommonPagedResponse1TacticChainApiServiceViewModelsOrderApiDtoTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull
• TacticChainApiServiceViewModelsCommonPagedResponse1TacticChainApiServiceViewModelsProductionApiDtoTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull
• TacticChainApiServiceViewModelsDeliveryNoteApiDto
• TacticChainApiServiceViewModelsDeliveryNoteDetailApiDto
• TacticChainApiServiceViewModelsDocumentTypeApiDto
• TacticChainApiServiceViewModelsOrderApiDto
• TacticChainApiServiceViewModelsOrderLineApiDto
• TacticChainApiServiceViewModelsOrderStageFormApiDto
• TacticChainApiServiceViewModelsOrderStageFormDatumApiDto
• TacticChainApiServiceViewModelsProductionApiDto
• TacticChainApiServiceViewModelsProductionRawMaterialApiDto
• TacticChainApiServiceViewModelsProductionSalesOrderApiDto
• TacticChainApiServiceViewModelsStageAttachmentApiDto

Documentation For Authorization

Authentication schemes defined for the API:

BearerToken

• Type: Bearer authentication

ApiKey

• Type: API key
• API key parameter name: X-API-Key
• Location: HTTP header

Timestamp

• Type: API key
• API key parameter name: X-Timestamp
• Location: HTTP header

Signature

• Type: API key
• API key parameter name: X-Signature
• Location: HTTP header

Author