Tachain.Sdk 0.1.0

Tachain.Sdk - the C# library for the Tactic Chain Public API

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

This C# SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• SDK version: 0.1.0
• Generator version: 7.25.0
• Build package: org.openapitools.codegen.languages.CSharpClientCodegen

<a id="frameworks-supported"></a>

Frameworks supported

<a id="dependencies"></a>

Dependencies

• Json.NET - 13.0.2 or later
• JsonSubTypes - 1.8.0 or later
• System.ComponentModel.Annotations - 5.0.0 or later

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

<a id="installation"></a>

Installation

Run the following command to generate the DLL

• [Mac/Linux] /bin/sh build.sh
• [Windows] build.bat

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using Tachain.Sdk.Api;
using Tachain.Sdk.Client;
using Tachain.Sdk.Model;

<a id="packaging"></a>

Packaging

A .nuspec is included with the project. You can follow the Nuget quickstart to create and publish packages.

This .nuspec uses placeholders from the .csproj, so build the .csproj directly:

nuget pack -Build -OutputDirectory out Tachain.Sdk.csproj

Then, publish to a local feed or other host and consume the new package via Nuget as usual.

<a id="usage"></a>

Usage

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

Connections

Each ApiClass (properly the ApiClient inside it) will create an instance of HttpClient. It will use that for the entire lifecycle and dispose it when called the Dispose method.

To better manager the connections it's a common practice to reuse the HttpClient and HttpClientHandler (see here for details). To use your own HttpClient instance just pass it to the ApiClass constructor.

HttpClientHandler yourHandler = new HttpClientHandler();
HttpClient yourHttpClient = new HttpClient(yourHandler);
var api = new YourApiClass(yourHttpClient, yourHandler);

If you want to use an HttpClient and don't have access to the handler, for example in a DI context in Asp.net Core when using IHttpClientFactory.

HttpClient yourHttpClient = new HttpClient();
var api = new YourApiClass(yourHttpClient);

You'll loose some configuration settings, the features affected are: Setting and Retrieving Cookies, Client Certificates, Proxy settings. You need to either manually handle those in your setup of the HttpClient or they won't be available.

Here an example of DI setup in a sample web project:

services.AddHttpClient<YourApiClass>(httpClient =>
   new PetApi(httpClient));

<a id="getting-started"></a>

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Tachain.Sdk.Api;
using Tachain.Sdk.Client;
using Tachain.Sdk.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();
            config.BasePath = "https://api.example.com";
            // Configure API key authorization: ApiKey
            config.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure API key authorization: Signature
            config.ApiKey.Add("X-Signature", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.ApiKeyPrefix.Add("X-Signature", "Bearer");
            // Configure Bearer token for authorization: BearerToken
            config.AccessToken = "YOUR_BEARER_TOKEN";
            // Configure API key authorization: Timestamp
            config.ApiKey.Add("X-Timestamp", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.ApiKeyPrefix.Add("X-Timestamp", "Bearer");

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new ApiDeclarationApi(httpClient, config, httpClientHandler);
            var xCredentialType = "Token";  // string | Use 'Token' with bearer authorization, or 'API Key' with signed API key headers. This header is mandatory in the deployed API.
            var attachmentId = "attachmentId_example";  // string? | query 方式传入的单个附件申报 ID。 (optional) 
            var formDataId = "formDataId_example";  // string? | query 方式传入的单个表单申报 ID。 (optional) 
            var tacticChainApiServiceControllersApiIntegrationV1ApiDeclarationDeleteRequest = new TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationDeleteRequest?(); // TacticChainApiServiceControllersApiIntegrationV1ApiDeclarationDeleteRequest? |  (optional) 

            try
            {
                // 申报信息删除接口。
                Model4 result = apiInstance.DeleteV1DeclarationDelete(xCredentialType, attachmentId, formDataId, tacticChainApiServiceControllersApiIntegrationV1ApiDeclarationDeleteRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling ApiDeclarationApi.DeleteV1DeclarationDelete: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

<a id="documentation-for-api-endpoints"></a>

Documentation for API Endpoints

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

<a id="documentation-for-models"></a>

Documentation for Models

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

<a id="documentation-for-authorization"></a>

Documentation for Authorization

Authentication schemes defined for the API: <a id="BearerToken"></a>

BearerToken

• Type: Bearer Authentication

<a id="ApiKey"></a>

ApiKey

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

<a id="Timestamp"></a>

Timestamp

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

<a id="Signature"></a>

Signature

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