Blueink.Client.Net 1.0.0

Blueink .NET Client

Official .NET client library for the Blueink eSignature API.

Installation

Install via NuGet Package Manager:

dotnet add package Blueink.Client.Net

Or via the Package Manager Console in Visual Studio:

Install-Package Blueink.Client.Net

Quick Start

using Blueink.Client.Net.v2;

// Initialize the client with your API key
var client = new BlueinkService("your-api-key");

// Or use environment variable BLUEINK_API_KEY
var client = new BlueinkService();

Features

• Bundles - Create and manage signature request bundles
• Packets - Access signer packets and signing URLs
• Persons - Manage signer contact information
• Templates - Work with reusable document templates
• Webhooks - Configure webhook endpoints for event notifications

Usage Examples

Create a Bundle with a Document

using Blueink.Client.Net.v2;
using Blueink.Client.Net.v2.Helper;

var client = new BlueinkService("your-api-key");

// Build a bundle request
var bundleHelper = new BundleHelper()
    .SetLabel("Contract Signature Request")
    .SetEmailSubject("Please sign this contract")
    .SetEmailMessage("Click the link below to review and sign.");

// Add a signer
bundleHelper.AddPacket()
    .SetName("John Doe")
    .SetEmail("john.doe@example.com");

// Add a document from file
bundleHelper.AddDocumentByPath("/path/to/contract.pdf");

// Create the bundle
var response = await client.BundleResource.CreateAsync(bundleHelper.AsRequest());

List Bundles

var bundles = await client.BundleResource.ListAsync();

foreach (var bundle in bundles.Data)
{
    Console.WriteLine($"Bundle: {bundle.Id} - {bundle.Label}");
}

Get Signing URL

var embedUrl = await client.PacketResource.EmbedUrlAsync(packetId);
Console.WriteLine($"Signing URL: {embedUrl.Url}");

Target Frameworks

This library supports:

• .NET 8.0 (LTS) - Cross-platform support for Windows, macOS, and Linux
• .NET Framework 4.6.2 - Windows legacy support

Configuration

API Key

Set your API key in one of the following ways:

1. Constructor parameter:

   var client = new BlueinkService("your-api-key");
   

2. Environment variable:

   export BLUEINK_API_KEY=your-api-key
   

   var client = new BlueinkService();
   

Custom Base URL

For testing or on-premise deployments:

var client = new BlueinkService("your-api-key", "https://custom-api.example.com/api/v2/");

Error Handling

The library provides typed exceptions for different error scenarios:

try
{
    var bundle = await client.BundleResource.RetrieveAsync(bundleId);
}
catch (BlueinkNotFoundException ex)
{
    Console.WriteLine($"Bundle not found: {ex.ResourceId}");
}
catch (BlueinkAuthenticationException ex)
{
    Console.WriteLine("Invalid API key");
}
catch (BlueinkRateLimitException ex)
{
    Console.WriteLine($"Rate limited. Retry after {ex.RetryAfterSeconds} seconds");
}
catch (BlueinkApiException ex)
{
    Console.WriteLine($"API error: {ex.Message}");
}

Documentation

• Blueink API Documentation
• Blueink Developer Portal

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

For support, please contact support@blueink.com or visit the Blueink Help Center.