Download the PHP package retech/sign-me without Composer
On this page you can find all versions of the php package retech/sign-me. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download retech/sign-me
More information about retech/sign-me
Files in retech/sign-me
Package sign-me
Short Description Celest Sign me SDK
License MIT
Homepage https://sign.celest.services
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package sign-me
SignMe (sign.celest.services) PHP-SDK
Handle your SignMe-requests in a human-digestible way. The goal is to make it feel like working with local models.
SignMe is a signature service targeted at integrators, rather than a pure UI-solution like most competitors.
Status: Private BETA. Please do not use in production yet
Example
Installation
composer require retech/sign-me
Usage
This package is a one-stop solution for all your remote signMe needs. It's functionality can be divided into three categories:
- api
- easy objects
- webhook reader
pure API
In order to use the public REST-API, method-wrappers simplify your calls. All of these methods return the result as assoc-array on success and throw the Exception Retech\Celest\SignMe\Exceptions\ConnectionException when things go wrong.
authenticate
| argument | type | required |
|---|---|---|
| $clientId | string | no (reads from env) |
| $apiKey | string | no (reads from env) |
The method establishes authentication using the environment variables _SIGN_ME_CLIENTID and _SIGN_ME_APIKEY. Alternatively, you can pass in your clientId & ApiKey directly.
get
| argument | type | required |
|---|---|---|
| $url | string | yes |
Execute GET-calls against the base-uri https://sign.celest.services/api/
post
| argument | type | required |
|---|---|---|
| $url | string | yes |
| $payload | array | no |
Execute POST-calls against the base-uri https://sign.celest.services/api/
put
| argument | type | required |
|---|---|---|
| $url | string | yes |
| $payload | array | yes |
Execute PUT-calls against the base-uri https://sign.celest.services/api/
delete
| argument | type | required |
|---|---|---|
| $url | string | yes |
Execute DELETE-calls against the base-uri https://sign.celest.services/api/
Easy Objects (OO)
Other than managing your transactions and company-settings, the use-case of the signMe API is predictable enough to make your day-to-day life easier with our object oriented interaction possibilities.
getDocuments
| argument | type | required |
|---|---|---|
| $page | int | no (defaults to 1) |
getDocument
| argument | type | required |
|---|---|---|
| $documentSlug | string | yes |
uploadDocument
| argument | type | required |
|---|---|---|
| $name | string | yes |
| $filePath | string | yes |
Currently accepts PDF & DOCX only
Entities
Document
- getDownloadUrl(): null|string
- getDownloadUrl(): null|string
- getFinalInstructions(): null|string
- setFinalInstructions(finalInstructions: null|string): void
- getWebhookUrl(): null|string
- setWebhookUrl(webhookUrl: null|string): void
- getSlug(): string
- getName(): string
- getRequesterHash(): string
- getFields(): array
- getSignatures(): array
- getSignature(signerHash: string): null|Signature
- addSignatory(signerHash: string, [signerName: null|string = null], [signerEmail: null|string = null]): Signature
-
update(): Document
Signature
- fields: array = [...]
- documentSlug: string
- getSignerHash(): string
- getSignerName(): null|string
- getSignerEmail(): null|string
- getIp(): null|string
- getSignedAt(): DateTimeImmutable|null
- isSigned(): bool
- setSignerName(signerName: null|string): void
- setSignerEmail(signerEmail: null|string): void
- addField(label: string, [page: int = 1], [type: string = 'signature']): Field
- getSignatureLink(): string
Field
- setType(type: string): void
- setSignerHash(signerHash: string): void
- setPage(page: int): void
- setX(x: float): void
- setY(y: float): void
- setWidth(width: float): void
- setHeight(height: float): void
- setLabel(label: null|string): void
- getLabel(): null|string
- getHeight(): float
- getWidth(): float
- getY(): float
- getX(): float
- getPage(): int
- getSignerHash(): string
- getType(): string
- update(): Field
- delete(): void
Webhook Reader
Lastly, let's have a quick look at the webhook validation tool included in this package
Support
Before the official release, no public support is provided.
License
MIT
