vigicorp / yousign-api-v3
Build the best experience of digital signature through your own platform. Increase your conversion rates, leverage your data and reduce your costs with Yousign API.
Requires
- php: ^7.4 || ^8.0
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^7.3
- guzzlehttp/psr7: ^1.7 || ^2.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.5
- phpunit/phpunit: ^8.0 || ^9.0
README
Build the best experience of digital signature through your own platform. Increase your conversion rates, leverage your data and reduce your costs with Yousign API.
Installation & Usage
Requirements
PHP 7.4 and later. Should also work with PHP 8.0.
Composer
To install the bindings via Composer, add the following to composer.json
:
{ "repositories": [ { "type": "vcs", "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" } ], "require": { "GIT_USER_ID/GIT_REPO_ID": "*@dev" } }
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'); // Configure Bearer authorization: bearerAuth $config = Yousign\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); $apiInstance = new Yousign\Client\Api\ApproverApi( // 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 ); $signature_request_id = 'signature_request_id_example'; // string | Signature Request Id $approver_id = 'approver_id_example'; // string | Approver Id try { $apiInstance->deleteSignatureRequestsSignatureRequestIdApproversApproverId($signature_request_id, $approver_id); } catch (Exception $e) { echo 'Exception when calling ApproverApi->deleteSignatureRequestsSignatureRequestIdApproversApproverId: ', $e->getMessage(), PHP_EOL; }
API Endpoints
All URIs are relative to https://api-sandbox.yousign.app/v3
Models
- Approver
- ApproverInfo
- ApproverToNotify
- ArchivedFile
- Archiving
- AuditTrailLocale
- Checkbox
- Checkbox1
- Checkbox2
- Consumption
- ConsumptionApi
- ConsumptionApp
- ConsumptionAppQualifiedElectronicSignatureIdentificationMode
- ConsumptionAppQualifiedElectronicSignatureIdentificationModeIdentityVerification
- Contact
- CreateContact
- CreateCustomExperience
- CreateCustomExperienceRedirectUrls
- CreateDocumentFromMultipart
- CreateElectronicSealFieldReadOnlyTextPayload
- CreateElectronicSealFieldSealPayload
- CreateElectronicSealPayload
- CreateElectronicSealPayloadFieldsInner
- CreateField
- CreateFieldFont
- CreateFollowersInner
- CreateSignatureRequest
- CreateSignatureRequestMetadata
- CreateSignatureRequestReminderSettings
- CreateSignatureRequestSignersInner
- CreateSignatureRequestTemplatePlaceholders
- CreateSignatureRequestTemplatePlaceholdersSignersInner
- CreateSigner
- CreateSignerDocumentRequest
- CreateWebhookSubscription
- CreateWebhookSubscriptionScopes
- CreateWebhookSubscriptionSubscribedEvents
- CreateWebhookSubscriptionWorkspaces
- CreateWorkspace
- CustomExperience
- CustomExperienceDisabledNotificationsType
- CustomExperienceRedirectUrls
- CustomExperienceSource
- Document
- DocumentInitials
- ElectronicSeal
- ElectronicSealAuditTrail
- ElectronicSealDocument
- ElectronicSealImage
- EmbeddedSignerWithSignatureLink
- FieldCheckbox
- FieldMention
- FieldRadioButtonGroup
- FieldRadioButtonGroupRadiosInner
- FieldReadOnlyText
- FieldSignature
- FieldText
- FieldType
- FieldsInput
- Follower
- Font
- FontFamily
- FontVariants
- FromExistingContact
- FromExistingContact1
- FromExistingSigner
- FromExistingUser
- FromExistingUser1
- FromScratch
- FromScratch1
- FromScratch1CustomText
- FromScratch1Info
- FromScratch1RedirectUrls
- FromScratchInfo
- GetContacts200Response
- GetCustomExperiences200Response
- GetSignatureRequests200Response
- GetSignatureRequestsSignatureRequestIdDocumentsDocumentIdFields200Response
- GetSignatureRequestsSignatureRequestIdDocumentsDocumentIdFields200ResponseDataInner
- GetSignatureRequestsSignatureRequestIdFollowers200Response
- GetSignatureRequestsSignatureRequestIdSignersSignerIdDocuments200Response
- GetTemplates200Response
- GetUsers200Response
- GetWorkspaces200Response
- InitialsArea
- ListElectronicSealImages200Response
- Locale
- MarkWorkspaceAsDefault
- Mention
- Mention1
- Mention2
- Metadata
- MetadataDataValue
- OtpMessage
- Pagination
- PatchCustomExperienceLogoRequest
- PatchSignatureRequestsSignatureRequestIdApproversApproverIdRequest
- PatchSignatureRequestsSignatureRequestIdApproversApproverIdRequestInfo
- PostArchives401Response
- PostSignatureRequestsSignatureRequestIdApproversRequest
- PostSignatureRequestsSignatureRequestIdCancelRequest
- PostSignatureRequestsSignatureRequestIdDocumentsDocumentIdReplaceRequest
- PostSignatureRequestsSignatureRequestIdReactivateRequest
- RadioGroup
- RadioGroup1
- RadioGroup1RadiosInner
- RadioGroup2
- RadioGroup2RadiosInner
- RadioGroupRadiosInner
- ReadOnlyText
- ReadOnlyText1
- Signature
- Signature1
- Signature2
- SignatureRequest
- SignatureRequestActivated
- SignatureRequestActivatedDocumentsInner
- SignatureRequestDeclineInformation
- SignatureRequestEmailNotification
- SignatureRequestEmailNotificationSender
- SignatureRequestInList
- SignatureRequestInListApproversInner
- SignatureRequestInListDocumentsInner
- SignatureRequestInListReminderSettings
- SignatureRequestInListSender
- SignatureRequestInListSignersInner
- SignatureRequestPlaceholderReadOnlyTextFieldSubstituteInput
- SignatureRequestPlaceholderSignerSubstituteFromContactIdInput
- SignatureRequestPlaceholderSignerSubstituteFromInfoInput
- SignatureRequestPlaceholderSignerSubstituteFromInfoInputInfo
- SignatureRequestPlaceholderSignerSubstituteFromUserIdInput
- SignatureRequestSignerFromContactIdInput
- SignatureRequestSignerFromInfoInput
- SignatureRequestSignerFromInfoInputInfo
- SignatureRequestSignerFromInfoInputRedirectUrls
- SignatureRequestSignerFromUserIdInput
- SignatureRequestStatus
- Signer
- SignerAuditTrail
- SignerCustomText
- SignerDeliveryMode
- SignerDocument
- SignerDocumentRequest
- SignerFieldsInner
- SignerInfo
- SignerRedirectUrls
- SignerSIPAddress
- SignerSign
- SignerSignWithUploadedSignatureImage
- SmsNotification
- SmsNotification1
- Template
- Text
- Text1
- Text2
- UpdateContact
- UpdateCustomExperience
- UpdateCustomExperienceRedirectUrls
- UpdateDocument
- UpdateField
- UpdateFieldFont
- UpdateSignatureRequest
- UpdateSignatureRequestMetadata
- UpdateSignatureRequestMetadataDataValue
- UpdateSignatureRequestReminderSettings
- UpdateSigner
- UpdateSignerInfo
- UpdateWebhookSubscription
- UpdateWorkspace
- UploadArchivedFile
- UploadElectronicSealDocument
- UploadElectronicSealImage
- User
- UserWorkspacesInner
- ViolationResponse
- WebhookSubscription
- WebhookSubscriptionScopes
- WebhookSubscriptionSubscribedEvents
- WebhookSubscriptionWorkspaces
- Workspace
- WorkspaceUsersInner
Authorization
Authentication schemes defined for the API:
bearerAuth
- Type: Bearer authentication
Tests
To run the tests, use:
composer install vendor/bin/phpunit
Author
About this package
This PHP package is automatically generated by the OpenAPI Generator project:
- API version:
3.0
- Generator version:
7.8.0
- Generator version:
- Build package:
org.openapitools.codegen.languages.PhpClientCodegen