README

The AccordFlow PHP SDK is a small cURL-based client for connecting PHP 8.1+ applications to the AccordFlow Signature API. It supports JSON requests, multipart file uploads, bearer-token authentication, and the tenant header used by local open API mode.

Installation

Add the SDK to your application with Composer. For local development, reference this repository path:

composer config repositories.accordflow path ../signature/sdk/php
composer require robo-meister/accord-flow-api:*

The package requires the PHP curl and json extensions.

Quick start

<?php

require __DIR__ . '/vendor/autoload.php';

use AccordFlow\AccordFlowClient;

$client = new AccordFlowClient(
    baseUrl: 'http://localhost:8080',
    bearerToken: getenv('ACCORDFLOW_TOKEN') ?: null,
    tenantId: getenv('ACCORDFLOW_TENANT') ?: null,
);

$status = $client->status();

Sign JSON payloads

$response = $client->sign([
    'envelopeId' => 456,
    'data' => 'Hello world',
    'documentType' => 'txt',
    'profile' => [
        'countryCode' => 'PL',
        'type' => 'EXTERNAL',
        'mode' => 'RAW',
    ],
    'username' => 'demo',
    'consent' => [
        'accepted' => true,
        'method' => 'CHECKBOX',
    ],
]);

$signature = $response['signature'] ?? null;
$redirectUrl = $response['redirectUrl'] ?? null;

The signing endpoint requires an existing envelope. Create or look up the envelopeId before calling sign, and include an accepted consent payload so the API can capture signer consent evidence. Some providers return redirectUrl for browser-based handoff flows. Redirect the signer to that URL and store any returned verificationReference for later verification lookups.

Sign and verify files

$signed = $client->signFile('/path/to/document.pdf', 456, [
    'profileId' => 123,
]);

$verification = $client->verifyFile(
    '/path/to/document.pdf',
    $signed['signature'],
    ['profileId' => 123],
);

// File signing also requires an existing envelope ID; the helper sends the
// second argument as the multipart `envelopeId` form field.

Generic requests

Use the generic helpers when the SDK has not added a typed wrapper yet:

$usage = $client->get('/api/auth/usage/demo');
$createdUser = $client->post('/api/auth/signup', [
    'username' => 'demo',
    'password' => 'change-me',
]);

Error handling

Non-2xx responses and transport failures throw AccordFlowException. The exception includes the HTTP status code and decoded response body when the API returns JSON.

use AccordFlow\AccordFlowException;

try {
    $client->verify([
        'data' => 'Hello world',
        'signature' => $signature,
        'documentType' => 'txt',
        'username' => 'demo',
    ]);
} catch (AccordFlowException $error) {
    error_log($error->getMessage());
    error_log((string) $error->getStatusCode());
}

robo-meister / accord-flow-api

Maintainers

Package info

Statistics

Security