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.1
• Generator version: 7.25.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Source repository and local build

This SDK is in the generated/python directory of the open-source SDK repository.

git clone https://github.com/ta-chain/tachain-sdk.git
cd tachain-sdk/generated/python
python3 -m pip install .

Requirements.

Python 3.10+

Installation & Usage

pip install

After this version is published on PyPI, install it with:

python3 -m pip install tachain-sdk==0.1.1

For a source build, use the checkout steps above.

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 | 查询返回的附件申报记录标识；也可在 Body 按单据和资料类型删除。 (optional)
    form_data_id = 'form_data_id_example' # str | 查询返回的表单记录标识；也可在 Body 按业务键删除。 (optional)
    tactic_chain_api_service_controllers_api_integration_v1_api_declaration_delete_request = {"stageId":"Order","orderSide":"SO","supplierExtNo":"ERP-SO-001-10","customerName":"客户名称","documentTypeCode":"INVOICE","deleteAttachments":true,"deleteForms":false} # 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

• DeleteV1DeclarationDelete200Response
• GetV1DeclarationListPaging200Response
• GetV1DeclarationRequiredDocuments200Response
• GetV1DeliveryListPaging200Response
• GetV1EnumGetList200Response
• GetV1MaterialListPaging200Response
• GetV1OrderPOListPaging200Response
• GetV1OrderReceiptPending200Response
• GetV1ProcessRouteListPaging200Response
• GetV1ProductListPaging200Response
• GetV1ProductionListPaging200Response
• GetV1ReferenceEnumValues200Response
• GetV1ReferenceMappings200Response
• Model1
• Model2
• Model3
• Model4
• PostV1DeclarationSubmit200Response
• PostV1DeclarationUploadFile200Response
• PostV1MaterialCreate200Response
• PostV1OrderCreate200Response
• PostV1OrderDeclarationVerification200Response
• PostV1OrderSubmitAudit200Response
• PostV1ProcessRouteCreate200Response
• PostV1ProductCreate200Response
• PostV1ProductionCreate200Response
• PutV1DeliveryConfirmReceipt200Response
• PutV1DeliveryReturnReceipt200Response
• PutV1OrderConfirmReceipt200Response
• TacticChainApiServiceControllersApiIntegrationV1ApiBomLineRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiBomLineResponse
• TacticChainApiServiceControllersApiIntegrationV1ApiCatalogDeleteRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationAttachmentResponse
• TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationDeleteRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationDocumentRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationFileRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationFormRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationFormResponse
• TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationListResponse
• TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationSubmitRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationSubmitResponse
• TacticChainApiServiceControllersApiIntegrationV1ApiDeliveryCreateRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiDeliveryDeleteRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiDeliveryDetailCreateRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiDeliveryDetailResponse
• TacticChainApiServiceControllersApiIntegrationV1ApiDeliveryDetailUpdateRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiDeliveryResponse
• TacticChainApiServiceControllersApiIntegrationV1ApiDeliveryUpdateRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiDocumentFormResponse
• TacticChainApiServiceControllersApiIntegrationV1ApiDocumentTypeResponse
• TacticChainApiServiceControllersApiIntegrationV1ApiEnumValueResponse
• TacticChainApiServiceControllersApiIntegrationV1ApiErrorResponse
• TacticChainApiServiceControllersApiIntegrationV1ApiFiberCompositionRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiFiberCompositionResponse
• TacticChainApiServiceControllersApiIntegrationV1ApiFileResponse
• TacticChainApiServiceControllersApiIntegrationV1ApiFileUploadResponse
• TacticChainApiServiceControllersApiIntegrationV1ApiMappingResponse
• TacticChainApiServiceControllersApiIntegrationV1ApiMaterialCreateRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiMaterialResponse
• TacticChainApiServiceControllersApiIntegrationV1ApiMaterialUpdateRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiOrderAcceptRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiOrderConfirmReceiptRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiOrderCreateRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiOrderDeclarationVerificationRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiOrderDeclarationVerificationResponse
• TacticChainApiServiceControllersApiIntegrationV1ApiOrderDeleteLineRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiOrderDeleteRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiOrderLineCreateRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiOrderLineResponse
• TacticChainApiServiceControllersApiIntegrationV1ApiOrderLineUpdateRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiOrderReceiptPendingLineResponse
• TacticChainApiServiceControllersApiIntegrationV1ApiOrderReceiptPendingResponse
• TacticChainApiServiceControllersApiIntegrationV1ApiOrderReceiptResult
• TacticChainApiServiceControllersApiIntegrationV1ApiOrderResponse
• TacticChainApiServiceControllersApiIntegrationV1ApiOrderSubmitAuditRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiOrderSubmitAuditResponse
• TacticChainApiServiceControllersApiIntegrationV1ApiOrderUpdateRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiPageResult1TacticChainApiServiceControllersApiIntegrationV1ApiDeliveryResponseTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull
• TacticChainApiServiceControllersApiIntegrationV1ApiPageResult1TacticChainApiServiceControllersApiIntegrationV1ApiMaterialResponseTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull
• TacticChainApiServiceControllersApiIntegrationV1ApiPageResult1TacticChainApiServiceControllersApiIntegrationV1ApiOrderResponseTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull
• TacticChainApiServiceControllersApiIntegrationV1ApiPageResult1TacticChainApiServiceControllersApiIntegrationV1ApiProcessRouteResponseTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull
• TacticChainApiServiceControllersApiIntegrationV1ApiPageResult1TacticChainApiServiceControllersApiIntegrationV1ApiProductResponseTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull
• TacticChainApiServiceControllersApiIntegrationV1ApiPageResult1TacticChainApiServiceControllersApiIntegrationV1ApiProductionResponseTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull
• TacticChainApiServiceControllersApiIntegrationV1ApiProcessRouteCreateRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiProcessRouteResponse
• TacticChainApiServiceControllersApiIntegrationV1ApiProcessRouteUpdateRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiProcessStepRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiProcessStepResponse
• TacticChainApiServiceControllersApiIntegrationV1ApiProductCreateRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiProductResponse
• TacticChainApiServiceControllersApiIntegrationV1ApiProductUpdateRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiProductionCreateRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiProductionDeleteRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiProductionRawMaterialCreateRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiProductionRawMaterialResponse
• TacticChainApiServiceControllersApiIntegrationV1ApiProductionRawMaterialUpdateRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiProductionResponse
• TacticChainApiServiceControllersApiIntegrationV1ApiProductionSalesOrderCreateRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiProductionSalesOrderResponse
• TacticChainApiServiceControllersApiIntegrationV1ApiProductionSalesOrderUpdateRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiProductionUpdateRequest
• TacticChainApiServiceControllersApiIntegrationV1ApiReceiptPendingItemResponse
• TacticChainApiServiceControllersApiIntegrationV1ApiReferencePageResponse1TacticChainApiServiceControllersApiIntegrationV1ApiEnumValueResponseTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull
• TacticChainApiServiceControllersApiIntegrationV1ApiReferencePageResponse1TacticChainApiServiceControllersApiIntegrationV1ApiMappingResponseTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull
• TacticChainApiServiceControllersApiIntegrationV1ApiResult1SystemStringSystemPrivateCoreLibVersion9000CultureNeutralPublicKeyToken7cec85d7bea7798e
• TacticChainApiServiceControllersApiIntegrationV1ApiResult1TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationListResponseTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull
• TacticChainApiServiceControllersApiIntegrationV1ApiResult1TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationSubmitResponseTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull
• TacticChainApiServiceControllersApiIntegrationV1ApiResult1TacticChainApiServiceControllersApiIntegrationV1ApiDeliveryResponseTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull
• TacticChainApiServiceControllersApiIntegrationV1ApiResult1TacticChainApiServiceControllersApiIntegrationV1ApiFileUploadResponseTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull
• TacticChainApiServiceControllersApiIntegrationV1ApiResult1TacticChainApiServiceControllersApiIntegrationV1ApiMaterialResponseTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull
• TacticChainApiServiceControllersApiIntegrationV1ApiResult1TacticChainApiServiceControllersApiIntegrationV1ApiOrderDeclarationVerificationResponseTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull
• TacticChainApiServiceControllersApiIntegrationV1ApiResult1TacticChainApiServiceControllersApiIntegrationV1ApiOrderReceiptPendingResponseTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull
• TacticChainApiServiceControllersApiIntegrationV1ApiResult1TacticChainApiServiceControllersApiIntegrationV1ApiOrderReceiptResultTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull
• TacticChainApiServiceControllersApiIntegrationV1ApiResult1TacticChainApiServiceControllersApiIntegrationV1ApiOrderResponseTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull
• TacticChainApiServiceControllersApiIntegrationV1ApiResult1TacticChainApiServiceControllersApiIntegrationV1ApiOrderSubmitAuditResponseTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull
• TacticChainApiServiceControllersApiIntegrationV1ApiResult1TacticChainApiServiceControllersApiIntegrationV1ApiProcessRouteResponseTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull
• TacticChainApiServiceControllersApiIntegrationV1ApiResult1TacticChainApiServiceControllersApiIntegrationV1ApiProductResponseTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull
• TacticChainApiServiceControllersApiIntegrationV1ApiResult1TacticChainApiServiceControllersApiIntegrationV1ApiProductionResponseTacticChainApiServiceVersion1000CultureNeutralPublicKeyTokenNull
• TacticChainApiServiceControllersApiIntegrationV1ApiVerificationFileResponse
• TacticChainApiServiceControllersApiIntegrationV1ApiVerificationResponse

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