squideyes / esignatures Goto Github PK

SquidEyes.ESignatures is a "fluent" C# client for the eSigntures.io contract-signing web-service, open-sourced on GitHub (under an MIT license; see License.md for details) and available as a NuGet.

The client is meant to be paired with a custom web-hook-processor like the included WebHookProcessor. A small bit of C# code (ContractSender) will also be needed to "kickoff" the contract-signing process and then you'd typically monitor the resulting Azure Service Bus messages with a program like MessageProcessor.

To use the demos you'll need to signup for a demo eSignatures.io account. Once the account is created, you'll then need to do the following:

1. Click on the "API & Automation" menu item (on the uper right-hand corner of the eSignatures.com site) and then take note of Your Secret Token. You'll need it to run the ContractSender demo.
2. Go to the https://esignatures.io/contract_templates web page and then import the MarketingAgreement.esiot file (located in the SquidEyes.ESignatures solution folder).
3. Take note of the TemplateId (a smallish light-gray GUID, labeled "ID," and found in the upper left-hand corner of the web-page). You'll need it to run the ContractSender demo.
4. Install Azurite, if you haven't done so already. Azurite is a local emulator for Azure Storage blobs and queues.
5. Configure a permanent and public Visual Studio Dev Tunnel, being sure to take note of the provisioned URL (for use in Step #7)
6. Run WebHookProcessor. As a side-effect, a "webhook-received" queue will be automatically created in Azurite, if it doesn't exist already.
7. Configure the following settings in the ContractSender appsettings.json file:

• TemplateId: TemplateId from Step #3, above
• BaseUri: Dev Tunnel address from Step #5, above
• CcPdfTos: Zero or more semicolon-separated email addresses
• VendorReplyTo: An optional "reply-to" email address
• VendorEmail Vendor's email address
• VendorMobile: Vendor's mobile phone number
• VendorLogoUri: URI to vendor's 128x128 pixel logo

9. Run the ContractSender project with the following command line arguments

• --AuthToken={Your Secret Token, from Step #1, above}
• --PartnerEmail={Partner's email address}
• --PartnerMobile={Partner's mobile phone number}

As an alternative, you may choose to keep your AuthToken in a UserSecrets file, with the JSON formatted as follows: {"AuthToken": "Your Secret Token"}

To simplify the testing process, you can use the same email and phone number for both the Vendor and Partner. In either case, only use an email and mobile phone number that you own since the Partner and Vendor signers will need to receive emails and then to fill in numbers on the resulting forms with a 6-digit code sent via SMS.

The fluent ContractSender has been designed to make kicking off the contract-signing process easy (see the ContractSender's Program.cs for for details). Aside from setting a bunch of configuration fields through the Contract object and a couple of fluent calls, it takes very little code to kick off the contract signing process:

    var request = new ContractSender<Metadata>(authToken, contract)
        .WithSignerInfo(p.Signer, p.Handling, p.Address)
        .WithSignerInfo(v.Signer, v.Handling, v.Address)
        .WithPlaceholder("client-id", metadata.ClientId)
        .WithPlaceholder("doc-code", metadata.DocCode)
        .AsTest();

    (await request.SendAsync(cts.Token)).Switch(
        HandleAccepted, HandleRejected, HandleFailed, HandleCancelled);

NOTE: The enclosed code has been developed for the author's own scenarios, and as such it exercises a less-than-complete fraction of the sSignatures.io functionality. In particular, no provision has been made for the creation and management of templates nor for embedded signing. Moreover, the library is rather opinionated and bespoke (i.e. the code receives and processes a variety of web-hook messages but makes no provision for stateful message management).