Skip to main content

Overview

image

Overview​

When integrating data verification solutions into your backend server, you can utilize the Primus Core SDK. For integrating zkTLS capabilities with DApps, please refer to the DApp Integration guide.

The Core SDK allows you to verify data through webpage endpoint responses, with support for repeated verification without additional calls. An authorized token is required to request private data.

To integrate, create a project in the Primus Develop Hub to obtain a paired appID and appSecret. Then, configure these credentials in your backend server to utilize the Core SDK and APIs.

Primus Core SDK supports two models: the Proxy TLS model and the MPC TLS model. You can specify the desired model by setting the "algorithmType" parameter during SDK integration.

For more details on setting up your project, refer to the Developer Hub.

How it Works​

Here's a simplified flow of how the Primus Core SDK works on your server:

1. Create Project: Create a project on the Primus Developer Hub to obtain a paired appID and appSecret, then configure them in your backend server.

2. Configure Verification Parameters: Ensure that two key parameters, including the request parameters and response data paths, are configured correctly. Refer to the simple example for guidance.

3. Execute zkTLS Protocol: Invoke the zkTLS protocol via your server to initiate the data verification process.

4. Verify Data Verification Result: Your server retrieves the verification result from the Core SDK and validates Primus' signature to ensure trustworthiness.

5. Execute Business Logic: Based on the verification result, your server executes the relevant business logic, such as submitting the proof on-chain or triggering other operations.

Interact with Blockchains​

The Primus zkTLS protocol is compatible with multiple blockchains. We provide smart contracts that can be deployed on various blockchains to verify data proofs generated by users via the zkTLS SDK.

Currently, support is available for several testnets and mainnets. For more details, refer to the on-chain interactions section.

Quick Start for Beginners​

  1. Installation Get the SDK set up in your project.

  2. Simple Example Understand how to use the Core SDK.

Stay Connected​

Keep up with the latest Primus developments: