Skip to content

SigniFlow/connect-php-sdk

BranchesTags

Repository files navigation

SigniFlow Logo

PHP Composer PHP version Apache-2 license

SigniFlow/connect-php-sdk - the PHP library for the SigniFlow OpenAPI Spec v1

SigniFlow API used to automate esignature workflow creation and management.

For more information, please visit https://www.signiflow.com/contact.

Installation & Usage

Requirements

PHP 7.2 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/signiflow/connect-php-sdk.git"
    }
  ],
  "require": {
    "signiflow/connect-php-sdk": ">=1.0.1*"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');





$config = new SigniFlowConnect\Configuration();
$config->setHost('https://Server-Url/API/SignFlowAPIServiceRest.svc');

$apiInstance = new SigniFlowConnect\Api\AuditsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$content_type = 'application/json'

$get_audit_document_request = 
json_decode('{"DocIDField":"string","TokenField":{"TokenExpiryField":"2019-08-24T14:15:22Z","TokenField":"aaa111"}}')
 // \SigniFlowConnect\Model\GetAuditDocumentRequest | ##### Get Audit Document Request Model


try {
    $result = $apiInstance->postGetAuditDocument($content_type, $get_audit_document_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuditsApi->postGetAuditDocument: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://server-url/API/SignFlowAPIServiceRest.svc

Class Method HTTP request Description
AuditsApi postGetAuditDocument POST /GetAuditDocument Get Audit Document
AuditsApi postGetDocumentAudit POST /GetDocumentAudit Get Document Audit
AuthenticationApi login POST /Login Login
AuthenticationApi postLogout POST /Logout Logout
AuthenticationApi postTokenExtend POST /TokenExtend Token Extend
AuthenticationApi postTokenValidate POST /TokenValidate Token Validate
PortfoliosApi postCreatePortfolio POST /CreatePortfolio Create Portfolio
PortfoliosApi postDownloadPortfolio POST /DownloadPortfolio Download Portfolio
PortfoliosApi postLinkToPortfolio POST /LinkToPortfolio Link To Portfolio
PortfoliosApi postSetDocumentOrder POST /SetDocumentOrder Set Document Order
PortfoliosApi postSharePortfolio POST /SharePortfolio Share Portfolio
PortfoliosApi postSharePortfolioNoEmail POST /SharePortfolio_No_Email Share Portfolio No Email
SigningCeremonyApi postMultipleSignersSigningCeremony POST /MultipleSignersSigningCeremony Multiple Signers Signing Ceremony
SigningCeremonyApi postSigningCeremonyV2 POST /SigningCeremonyV2 Signing Ceremony V2
TemplatesApi postApplyPrepperTemplate POST /ApplyPrepperTemplate Apply a Prepper template
TemplatesApi postGetDocumentTagFieldBoxPosition POST /GetDocumentTagFieldBoxPosition Get Document Tag Field Box Position
TemplatesApi postGetDocumentTagFieldPosition POST /GetDocumentTagFieldPosition Get Document Tag Field Position
TemplatesApi postGetPrepperTemplate POST /GetPrepperTemplate Get Prepper Template
TemplatesApi postGetPrepperTemplateList POST /GetPrepperTemplateList Get Prepper Template List
ViewersApi postGetDocLink POST /GetDocLink Get Document Link
ViewersApi postGetDocumentPrepperLink POST /GetDocumentPrepperLink Get Document Prepper Link
WorkFlowApi createWorkflow POST /CreateWorkflow Create Workflow
WorkFlowApi getDocument POST /GetDoc Get Document
WorkFlowApi postAddWorkflowStep POST /AddWorkflowStepV2 Add a Workflow step
WorkFlowApi postCancelFlow POST /CancelFlow Cancel Flow
WorkFlowApi postDeleteDoc POST /DeleteDoc Delete Document
WorkFlowApi postDocPrepperAddField POST /DocPrepperAddFieldsFlowID Document Prepper Add Fields
WorkFlowApi postDocPrepperAdvancedFields POST /DocPrepperAdvancedFields Document Prepper Add Advanced Fields
WorkFlowApi postFullWorkflow POST /FullWorkflow FullWorkflow
WorkFlowApi postGetDocStatus POST /GetDocStatus Get Document Status
WorkFlowApi postInitiateFlow POST /InitiateFlow Initiate Flow
WorkFlowApi postInitiateFlowNoEmail POST /InitiateFlow_No_Email Initiate Flow No Email
WorkFlowApi postInitiateFlowNoInitialEmail POST /InitiateFlow_No_Initial_Email Initiate Flow No Initial Email
WorkFlowApi postWorkflowSign POST /WorkflowSign Workflow Sign

Models

Authorization

All endpoints do not require authorization.

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

support@signiflow.com

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0
    • Package version: 1.0.1
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen

Contributing

Send bug reports, feature requests, and code contributions to the API specifications repository, as this repository contains only the generated SDK code.

License

Copyright 2021 SigniFlow, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

About

No description, website, or topics provided.

Resources

Readme
Activity
Custom properties

Stars

1 star

Watchers

2 watching

Forks

0 forks
Report repository

Releases 1

1.0.1 Latest
Jul 13, 2021

Packages

No packages published

Languages