PHPackages registrucentras/onesign - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. registrucentras/onesign ActiveLibrary[API Development](/categories/api) registrucentras/onesign ======================= GoSign OneSign API client for PHP v1.2.0(1y ago)62.2k6[2 PRs](https://github.com/registrucentras/onesign/pulls)MITPHPPHP ^7.2.5 || ^8.4CI failing Since Sep 22Pushed 1y ago2 watchersCompare [ Source](https://github.com/registrucentras/onesign)[ Packagist](https://packagist.org/packages/registrucentras/onesign)[ RSS](/packages/registrucentras-onesign/feed)WikiDiscussions master Synced today READMEChangelog (4)Dependencies (18)Versions (6)Used By (0) OneSign PHP API Client ====================== [](#onesign-php-api-client) Reikalavimai ------------ [](#reikalavimai) - PHP 7.4+ arba 8.0+ #### Patariam [](#patariam) - Nginx - php-fpm Funkcijos --------- [](#funkcijos) - PDF dokumentų pasirašymas; - laiko žymų uždėjimas ant PDF dokumentų. Diegimas -------- [](#diegimas) Norėdami greitai integruoti šią biblioteką į savo PHP projektą naudokite [Composer](https://getcomposer.org) PHP paketų valdymo įrankį. Jei jūsų projektas nenaudoja PSR standartu paremtą HTTP klientą, papildomai [įdiekite vieną iš jų](https://packagist.org/providers/psr/http-client-implementation). Daugiau informacijos galite rasti [paslaugų teikimo tvarkoje](https://registrucentras.github.io/gosign-api-integration/getting-started.html). ### Standartinis diegimas [](#standartinis-diegimas) ``` $ composer require "registrucentras/onesign:^1.2.0" ``` Naudojimas ---------- [](#naudojimas) Inicijuokite API kliento objektą. ``` use RegistruCentras\OneSign\Client; $client = new Client(); ``` ### Autentifikavimas, užklausų ir atsakymų validacija [](#autentifikavimas-užklausų-ir-atsakymų-validacija) Pasirašymo paslaugos saugumas ir kliento autentifikavimas užtikrinamas naudojant asimetrinę kriptografiją: - jūsų privatus raktas, naudojamas siunčiamam turiniui pasirašyti; - jūsų viešas raktas (perduodamas GoSign administratoriui), naudotojui ir jo siunčiamam turiniui patvirtinti; - viešas GoSign raktas (pateikiamas individualiai GoSign administratoriaus), užklausos atsakymo vientisumui užtikrinti. kaip generuoti raktus pateikiama [raktų generavimo instrukcijoje](https://registrucentras.github.io/gosign-api-integration/key-generation.html). ``` $client->configure( 'api_endpoint_adresas', 'jums_suteiktas_id', \file_get_contents(__DIR__ . '/../Keys/private.key'), // jūsų sugeneruotas private raktas 'private_key_passprahse', \file_get_contents(__DIR__ . '/../Keys/public.key') // jums perduotas public raktas GoSign.lt administratoriaus ); ``` ### Pavyzdžiai [](#pavyzdžiai) ### Dokumento pasirašymas [](#dokumento-pasirašymas) Dokumento pasirašymas vyksta keliais etapais: - inicijuojama pasirašymo transkacija (`$client->init()`); - asmuo, pasirašantis dokumentą, nukreipiamas į pasirašymo puslapį; - pasirašomas dokumentas; - asmuo, pasirašantis dokumentą, nukreipiamas į (`$client->init()`) metode nurodytą pasirašymo sėkmės puslapį; - gaunamas pasirašytas dokumentas (`$client->result()`). Inicijuota pasirašymą galite nutraukti (`$client->cancel()`) (iki dokumento pasirašymo). #### Pasirašymo inicijavimas [](#pasirašymo-inicijavimas) Dokumento pasirašymo inicijavimui yra naudojami keturi esybių objektai: - `Signer` - aprašomas pasirašantis asmuo; - `File` - aprašomas pasirašomas failas; - `SignatureConfiguration` - aprašoma parašo konfigūracija; - `Configuration` - aprašoma pasirašymo konfigūracija. ``` use RegistruCentras\OneSign\Entity\Signer; use RegistruCentras\OneSign\Entity\File; use RegistruCentras\OneSign\Entity\SignatureConfiguration; use RegistruCentras\OneSign\Entity\Configuration; use RegistruCentras\OneSign\Entity\SigningType; $signer = (new Signer()) ->setPersonalCode('asmens_kodas') ; $file = (new File()) ->setName('failo_pavadinimas') ->setContent(\file_get_contents(__DIR__ . '/../Files/sample.pdf')) ; $signatureConfiguration = new SignatureConfiguration(); $configuration = (new Configuration()) ->setResponseUrl('http://example.com/backlink') ->setSigningType(SigningType::SIGNATURE_WITH_TIMESTAMP_OCSP) ; $response = $client ->init($signer, $file, $signatureConfiguration, $configuration) ; $transactionId = $response->getTransactionId(); $signingUrl = $response->getSigningUrl(); ``` rezultate gauname: - `transactionId` - pasirašymo transakcijos unikalus numeris; - `signingUrl` - pasirašymo puslapio adresas, į kurį bus nukreipiamas pasirašytojas. Daugiau veikiančių pavyzdžių galite rasti [kliento testavimo scenarijuose](tests/IntegrationTest.php). #### Pasirašymo transakcijos būsenos patikrinimas ir pasirašyto failo gavimas [](#pasirašymo-transakcijos-būsenos-patikrinimas-ir-pasirašyto-failo-gavimas) Pasirašyto dokumento gavimui yra naudojamas vienas esybių objektas: - `Transaction` - pasirašymo transakcijos unikalus numeris gautas iš pasirašymo inicijavimo etapo. ``` use RegistruCentras\OneSign\Entity\Transaction; use RegistruCentras\OneSign\HttpClient\Message\Response\Status\SigningResponseStatus; $transaction = (new Transaction()) ->setTransactionId($transactionId) ; $response = $client ->result($transactionId) ; $status = $response->getStatus(); ``` rezultate gauname: - `status` - pasirašymo transakcijos būsena (`SigningResponseStatus::IN_PROGRESS` - pasirašymas inicijuotas, laukiama dokumento pasirašymo, `SigningResponseStatus::SIGNED` - dokumentas pasirašytas, `SigningResponseStatus::CANCELED` - dokumento pasirašymas buvo nutrauktas); prie `SigningResponseStatus::IN_PROGRESS` pateikiamas papildomas parametras: - `signerCertificate` - asmens, kuris pasirašo dokumentą, sertifikatas; ``` $signerCertificate = $response->getSignerCertificate(); ``` prie `SigningResponseStatus::SIGNED` pateikiami papildomi parametrai: - `file` - failo esybės objektas; gaukite pasirašyto failo pavadinimą: ``` $fileName = $response->getFile()->getFileName(); ``` gaukite pasirašyto failo turinį: ``` $fileContent = $response->getFile()->getContent(); ``` - `signerCertificate` - asmens, kuris pasirašė dokumentą, sertifikatas; ``` $signerCertificate = $response->getSignerCertificate(); ``` - `signerCertificateTrusted` - asmens, kuris pasirašė dokumentą, sertifikato validumas (boolean: `true` - validus, `false` - ne validus). ``` $signerCertificateTrusted = $response->getSignerCertificateTrusted(); ``` #### Pasirašymo nutraukimas [](#pasirašymo-nutraukimas) Pasirašymo nutraukimui yra naudojamas vienas esybių objektas: - `Transaction` - pasirašymo transakcijos unikalus numeris gautas iš pasirašymo inicijavimo etapo. ``` use RegistruCentras\OneSign\Entity\Transaction; use RegistruCentras\OneSign\HttpClient\Message\Response\Status\CancelSigningResponseStatus; $transaction = (new Transaction()) ->setTransactionId($transactionId) ; $response = $client ->cancel($transactionId) ; $status = $response->getStatus(); ``` rezultate gauname: - `status` - pasirašymo transakcijos būsena (`CancelSigningResponseStatus::CANCELED` - pasirašymas buvo nutrauktas, `CancelSigningResponseStatus::ERROR` - pasirašymo nutraukti nepavyko); Atitiktis --------- [](#atitiktis) - [Standard PHP package skeleton](https://github.com/php-pds/skeleton); - HTTP message interfaces (PSR-7); - HTTP Server Request Handlers, Middleware (PSR-15); - HTTP factories (PSR-17); - Code styles (PSR-12); - PHPDoc standartas (PSR-5, PSR-19); - Unit and integration testai; - Ištestuota su [Github Actions](https://github.com/registrucentras/onesign/actions); - [PHPStan](https://github.com/phpstan/phpstan) (Level: max); - Docker konteineris su Xdebug palaikymu. Plėtra ------ [](#plėtra) Esame atviri atviro kodo politikai. Norite prisidėti prie projekto? Visada laukiame pakeitimų. Kaip tai padaryti? Atlikite pakeitimus atskiroje kodo atšakoje ir siųkite „Pull“ užklausas į pagrindinę kodo atšaką. Prašome tik: - vadovautis [Symfony karkaso standartais](https://symfony.com/doc/current/contributing/code/standards.html); - įsitikinti, kad po pakeitimo esami testai veikia tinkamai; - įsitikinti, kad pakeitimas yra "padengtas" testu; - vykdyti nuoseklią kodo versijų kontrolę: kiekvieno pakeitimo aprašymas yra prasmingas; - naudoti [rebase](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) kad išvengumėte konfilktų; - nepamiršti ir dokumentacijos; - statiniam kodui skenuoti naudoti [psalm](https://psalm.dev/) ir [PHP\_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer); - kodo kokybei užtikrinti naudoti [phpstan](https://github.com/phpstan/phpstan); - automatiniam refaktorinimui naudoti [rector](https://github.com/rectorphp/rector). Nuo ko pradėti? --------------- [](#nuo-ko-pradėti) Įsitikinkite, kad jūsų darbo vieta palaiko `Docker` ir komandų vykdymo `Make` PĮ. ``` $ git clone $ make install ``` Paleiskite automatinius testus ir kodo analizės įrankius: ``` $ make test ``` ### Health Score 42 — FairBetter than 90% of packages Maintenance44 Moderate activity, may be stable Popularity23 Limited adoption so far Community16 Small or concentrated contributor base Maturity72 Established project with proven stability Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~311 days Total 5 Last Release 444d ago PHP version history (2 changes)v1.0.0PHP ^7.2.5 || ^8.0 v1.2.0PHP ^7.2.5 || ^8.4 ### Community Maintainers ![](https://www.gravatar.com/avatar/97ffaa302bb33aa5180034adc1d5162aba847623b1df74736a32ea03bf2c0725?d=identicon)[registrucentras](/maintainers/registrucentras) --- Top Contributors [![registrucentras](https://avatars.githubusercontent.com/u/84323247?v=4)](https://github.com/registrucentras "registrucentras (14 commits)")[![benycode](https://avatars.githubusercontent.com/u/39025147?v=4)](https://github.com/benycode "benycode (12 commits)")[![VaidotasAlionis](https://avatars.githubusercontent.com/u/198548772?v=4)](https://github.com/VaidotasAlionis "VaidotasAlionis (4 commits)")[![girvydas](https://avatars.githubusercontent.com/u/1083257?v=4)](https://github.com/girvydas "girvydas (1 commits)")[![kick-the-bucket](https://avatars.githubusercontent.com/u/7068596?v=4)](https://github.com/kick-the-bucket "kick-the-bucket (1 commits)") --- Tags GoSignOneSignGoSign APIElektroninis parašas ### Embed Badge ![Health badge](/badges/registrucentras-onesign/health.svg) ``` [![Health](https://phpackages.com/badges/registrucentras-onesign/health.svg)](https://phpackages.com/packages/registrucentras-onesign) ``` ### Alternatives [openai-php/client OpenAI PHP is a supercharged PHP API client that allows you to interact with the Open AI API 5.8k22.6M232](/packages/openai-php-client)[knplabs/github-api GitHub API v3 client 2.2k15.8M187](/packages/knplabs-github-api)[sylius/sylius E-Commerce platform for PHP, based on Symfony framework. 8.4k5.6M650](/packages/sylius-sylius)[phpro/http-tools HTTP tools for developing more consistent HTTP implementations. 28137.8k](/packages/phpro-http-tools)[m4tthumphrey/php-gitlab-api GitLab API v4 client for PHP 9485.4M64](/packages/m4tthumphrey-php-gitlab-api)[getbrevo/brevo-php Official Brevo provided RESTFul API V3 php library 963.1M35](/packages/getbrevo-brevo-php) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)