affinidi_tdk_credential_issuance_client (EXPERIMENTAL)

Affinidi TDK dart client for Affinidi CREDENTIAL ISSUANCE

Requirements

Installation & Usage

pub.dev

To use the package from pub.dev, please include the following in pubspec.yaml

dependencies:
  affinidi_tdk_credential_issuance_client: ^1.0.0

Github

This Dart package is published to Github, please include the following in pubspec.yaml

dependencies:
  affinidi_tdk_credential_issuance_client:
    git:
      url: https://github.com/affinidi/affinidi-tdk.git
      ref: main
      path: clients/dart/credential_issuance_client

Local development

To use the package from your local drive, please include the following in pubspec.yaml

dependencies:
  affinidi_tdk_credential_issuance_client:
    path: /path/to/affinidi_tdk_credential_issuance_client

Install dependencies

dart pub get

Getting Started

Please follow the installation procedure and then run the following:

import 'package:affinidi_tdk_credential_issuance_client/affinidi_tdk_credential_issuance_client.dart';


final api = AffinidiTdkCredentialIssuanceClient().getConfigurationApi();
final CreateIssuanceConfigInput createIssuanceConfigInput = ; // CreateIssuanceConfigInput | Request body of create configuration

try {
    final response = await api.createIssuanceConfig(createIssuanceConfigInput);
    print(response);
} catch on DioException (e) {
    print("Exception when calling ConfigurationApi->createIssuanceConfig: $e\n");
}

Documentation for API Endpoints

All URIs are relative to https://apse1.api.affinidi.io/cis

Class Method HTTP request Description
ConfigurationApi createIssuanceConfig POST /v1/configurations
ConfigurationApi deleteIssuanceConfigById DELETE /v1/configurations/{configurationId}
ConfigurationApi getIssuanceConfigById GET /v1/configurations/{configurationId}
ConfigurationApi getIssuanceConfigList GET /v1/configurations
ConfigurationApi updateIssuanceConfigById PUT /v1/configurations/{configurationId}
CredentialsApi batchCredential POST /v1/{projectId}/batch_credential Allows wallets to claim multiple credentials at once.
CredentialsApi generateCredentials POST /v1/{projectId}/credential
CredentialsApi getClaimedCredentials GET /v1/{projectId}/configurations/{configurationId}/credentials Get claimed credential in the specified range
CredentialsApi getIssuanceIdClaimedCredential GET /v1/{projectId}/configurations/{configurationId}/issuances/{issuanceId}/credentials Get claimed VC linked to the issuanceId
DefaultApi changeCredentialStatus POST /v1/{projectId}/configurations/{configurationId}/issuance/change-status change credential status.
DefaultApi listIssuanceDataRecords GET /v1/{projectId}/configurations/{configurationId}/issuance/issuance-data-records List records
IssuanceApi issuanceState GET /v1/{projectId}/issuance/state/{issuanceId}
IssuanceApi issueCredentials POST /v1/{projectId}/credential/issue
IssuanceApi listIssuance GET /v1/{projectId}/issuance
IssuanceApi startIssuance POST /v1/{projectId}/issuance/start
OfferApi getCredentialOffer GET /v1/{projectId}/offers/{issuanceId}
WellKnownApi getWellKnownOpenIdCredentialIssuer GET /v1/{projectId}/.well-known/openid-credential-issuer

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

AwsSigV4

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

ApiKey

  • Type: API key
  • API key parameter name: x-api-key
  • Location: HTTP header

bearerAuth

  • Type: HTTP Bearer Token authentication (JWT)

ConsumerTokenAuth

  • Type: API key
  • API key parameter name: authorization
  • Location: HTTP header

UserTokenAuth

  • Type: API key
  • API key parameter name: authorization
  • Location: HTTP header

ProjectTokenAuth

  • Type: API key
  • API key parameter name: authorization
  • Location: HTTP header

HeritageTokenAuth

  • Type: API key
  • API key parameter name: authorization
  • Location: HTTP header

Author

info@affinidi.com

Libraries

affinidi_tdk_credential_issuance_client