dyrynda/annature

A PHP integration for the Annature eSignature and client verification API

dev-main 2024-03-18 11:52 UTC

Requires

• illuminate/collections: ^10.0|^11.0
• saloonphp/saloon: ^3.7

Requires (Dev)

• laravel/pint: ^1.14
• pestphp/pest: ^2.34

MIT

• Michael Dyrynda

README

Note

This SDK is still a work in progress. Whilst functional for the implemented resources, it is built against the Annature documentation for optimistic scenarios.

Annature is an Australian-based eSignature and client verification provider.

Use of this SDK requires an account with Annature, as well as an API ID and Key.

My immediate use-case for this API was creation of envelopes to be sent to signatories, so those resources have been built first.

The package leverages Saloon for it's HTTP layer.

Resources

Resource	Status
Accounts	Implemented
Documents	Implemented
Endpoints	Not implemented
Envelopes	Implemented
Fields	Field object only
Groups	Not implemented
Organisations	Not implemented
Recipients	Recipient object only
Templates	Not implemented

Installation

composer require dyrynda/annature-php

Usage

use Dyrynda\Annature\Annature;
use Dyrynda\Annature\Data\Envelopes\CreateEnvelopeData;

$annature = new Annature(
    id: 'your-annature-id',
    key: 'your-annature-key'
);

$envelope = $annature->envelopes()->create(
    new CreateEnvelopeData(...)
);

Laravel

If you are using Laravel, you may use the laravel-annature package, which uses this SDK as a dependency, to get started quickly.