Sadq.IntegrationSDK 1.0.0

Sadq.IntegrationSDK

Client SDK for the Sadq e-signature IntegrationService API (v1). Handles authentication, envelope creation, signer invitations, envelope status, file download, webhooks, and more.

• Target: netstandard2.0 — runs on .NET Framework 4.6.2+, .NET Core 2.0+, .NET 5 / 6 / 7 / 8, Unity 2018+, Xamarin, Mono.
• Dependencies: only System.Text.Json (for JSON serialization).

Install

dotnet add package Sadq.IntegrationSDK

Or in a csproj:

<PackageReference Include="Sadq.IntegrationSDK" Version="1.0.0" />

Quick start

The SDK is split into two clients — one for auth, one for API calls. Both are constructed directly; no DI container required.

using Sadq.IntegrationSDK;
using Sadq.IntegrationSDK.Auth.Models;
using Sadq.IntegrationSDK.Settings;
using Sadq.IntegrationSDK.V1.Models.Requests;

// 1. Acquire a bearer token.
using var auth = new SadqAuthClient(new SadqSdkOptions
{
    BaseUrl = "https://api.sadq.sa",   // gateway / host root
});

var token = await auth.Auth.AuthenticateAsync(new SadqTokenRequest
{
    Username      = "...",
    Password      = "...",
    AccountId     = new Guid("..."),
    AccountSecret = "...",
});

// 2. Use the token for every API call.
using var sadq = new SadqIntegrationClient(new IntegrationOptions
{
    BaseUrl     = "https://api.sadq.sa",
    AccessToken = token.AccessToken,
});

// Initiate an envelope from a base64 file:
var resp = await sadq.V1.Documents.InitiateEnvelopeAsync(new EnvelopRequest
{
    File = new EnvelopFile { fileName = "contract.pdf", File = base64 },
});

// Check its status:
var status = await sadq.V1.Documents.GetEnvelopeStatusAsync(resp.Data.EnvelopeId);

// Register a webhook:
var webhook = await sadq.V1.Webhooks.CreateAsync(new WebHookCreateDto
{
    WebhookUrl = "https://yoursite.example/sadq-events",
    IsDefault  = true,
});

API surface

SadqAuthClient

• Auth.AuthenticateAsync(SadqTokenRequest) — fetch a bearer token.

SadqIntegrationClient

• V1.Documents — InitiateEnvelopeAsync, InitiateEnvelopeMultipartAsync, InitiateByTemplateAsync, BulkInitiateEnvelopeAsync, InitiateAndInviteAsync, GetEnvelopeStatusAsync, GetEnvelopeStatusByReferenceNumberAsync, DownloadAsync, DownloadEnvelopeFilesAsync, DownloadCompletedBase64Async, CancelEnvelopeAsync.
• V1.Invitations — InviteAsync, InviteByEnvelopeAsync, BulkInviteAsync, RemindAsync, BulkRemindAsync, ExtendInvitationAsync, ExtendEnvelopeInvitationsAsync.
• V1.Webhooks — CreateAsync, GetAccountWebhooksAsync, BulkCreateAsync, GetByIdAsync, DeleteAsync.
• V2.Invitations — SendInvitationAsync.
• V3.Invitations — InitiateInvitationAsync.

Errors

All API calls return BaseResponse<T> — inspect ErrorCode before reading Data. Transport/HTTP failures surface as SadqApiException; configuration problems surface as SadqSdkOptionsException.

License

Proprietary — © Sadq Solutions.