AffinidiTdk.IotaClient 1.1.0

<a id="top"></a>

Affinidi TDK .NET client for Iota

Affinidi TDK dotnet client for Affinidi IOTA

Getting Started

Prerequisites

• .NET 8 SDK (minimum version: 8.0.400)

Check your installed version:

dotnet --version

Installation

These are the steps to get you started with a dotnet project and integration with AffinidiTdk.IotaClient. Note: Steps 1 & 2 are optional if you have already created a project.

1. Create a new project directory

*On macOS / Linux / Windows (Powershell) 😗

mkdir MyProject
cd MyProject

2. Initialize a .NET Project (dotnet template: console)

dotnet new console

3. Installing the TDK Client (from nuget.org)

dotnet add package AffinidiTdk.IotaClient

<p align="right">(<a href="#top">back to top</a>)</p>

Usage

1. Import the required dependencies

The dependencies required may differ based on the Client Api used in your application.

using AffinidiTdk.AuthProvider;
using AffinidiTdk.IotaClient.Api;
using AffinidiTdk.IotaClient.Client;
using AffinidiTdk.IotaClient.Model;

2. Create an AuthProvider

• The AuthProvider is a separate package which you will need to install. Get it from nuget.org. NOTE: This step requires you to first create your Personal Access Token (PAT). Please refer to this link

var authProvider = new AuthProvider(new AuthProviderParams
{
    // Please generate your own Personal Access Tokens (PAT). 
    // Refer to https://docs.affinidi.com/dev-tools/affinidi-tdk/get-access-token/#create-a-personal-access-token-pat for the guide on creating your own PAT.    
    TokenId = "YOUR_TOKEN_ID",
    PrivateKey = "YOUR_PRIVATE_KEY",
    ProjectId = "YOUR_PROJECT_ID"
    // Passphrase = "YOUR_PASSPHRASE", // Required only if provided in the PAT
});

3. Fetch the ProjectScopedToken from the AuthProvider

string projectScopedToken = await authProvider.FetchProjectScopedTokenAsync();

4. Create an instance of the Client Configuration

• In this step, you can set the projectScopedToken in the configuration.

Configuration config = new Configuration();

config.AddApiKey("authorization", projectScopedToken);

5. Create an instance of the Client Api you intend to use

• In this step, you should pass the config as a constructor argument in the Client Api. NOTE: Each Operation requires different input. Please refer to the <a href="#documentation">operation documentation</a> for the details.

CallbackApi api = new CallbackApi(config);

var callbackInput = new CallbackInput();

CallbackResponseOK result = api.IotOIDC4VPCallback(callbackInput);

Console.WriteLine(result.ToJson());

For more examples, please refer to the Documentation.

Token Refresh

When handling tokens, it is important that your project access token is managed properly to prevent failures due to expired tokens.

We have created an example code which handles the automatic refresh of tokens to ensure that the token used in the client APIs are fresh.

<p align="right">(<a href="#top">back to top</a>)</p>

Documentation

Client Api Documentation

Note: Each Client API operation requires a different authorization token. Please check the operation details for the type of token required to use the operation properly.

Documentation For Models

• AlreadyExistsError
• AwsExchangeCredentials
• AwsExchangeCredentialsOK
• AwsExchangeCredentialsProjectToken
• AwsExchangeCredentialsProjectTokenOK
• AwsExchangeCredentialsProjectTokenOKCredentials
• CallbackInput
• CallbackResponseOK
• ConsentDto
• CorsAwsExchangeCredentialsOK
• CorsAwsExchangeCredentialsProjectTokenOK
• CorsFetchIotaVpResponseOK
• CorsInitiateDataSharingRequestOK
• CorsIotOidc4vpcallbackOK
• CorsIotaExchangeCredentialsOK
• CreateDcqlQueryInput
• CreateIotaConfigurationInput
• CreatePexQueryInput
• DcqlQueryDto
• DeletePexQueriesInput
• FetchIOTAVPResponseInput
• FetchIOTAVPResponseOK
• GetIotaConfigurationMetaDataOK
• InitiateDataSharingRequestInput
• InitiateDataSharingRequestOK
• InitiateDataSharingRequestOKData
• InvalidParameterError
• InvalidParameterErrorDetailsInner
• IotaConfigurationDto
• IotaConfigurationDtoClientMetadata
• IotaExchangeCredentials
• IotaExchangeCredentialsOK
• IotaExchangeCredentialsOKCredentials
• ListConfigurationOK
• ListDcqlQueriesOK
• ListLoggedConsentsOK
• ListPexQueriesOK
• MessagePublishingError
• NotFoundError
• OperationForbiddenError
• PexQueryDto
• PrepareRequest
• PrepareRequestCreated
• PrepareRequestCreatedData
• ResourceLimitExceededError
• SavePexQueriesUpdateInput
• SavePexQueriesUpdateInputQueriesInner
• UpdateConfigurationByIdInput
• UpdateConfigurationByIdOK
• UpdateDcqlQueryInput
• UpdatePexQueryInput
• VPTokenValidationError

<p align="right">(<a href="#top">back to top</a>)</p>

Support & Feedback

If you face any issues or have suggestions, please don't hesitate to contact us using this link.

Reporting technical issues

If you have a technical issue with the Affinidi TDK's codebase, you can also create an issue directly in GitHub.

1. Ensure the bug was not already reported by searching on GitHub under Issues.

2. If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

<p align="right">(<a href="#top">back to top</a>)</p>

Contributing

We enjoy community contributions! Whether it’s bug fixes, feature requests, or improving docs, your input helps shape the Affinidi TDK.

• Head over to our CONTRIBUTING to get started.
• Have an idea? Start a discussion in GitHub Discussions or Discord

<p align="right">(<a href="#top">back to top</a>)</p>