saleschamp / webhooks
Provides utilities required for signing and authenticating calls to public URLs.
Installs: 14 207
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 11
Forks: 0
Open Issues: 1
Requires
- php: >= 5.4.0
- nette/http: ^2.3
Requires (Dev)
- nette/tester: ~1.7
This package is not auto-updated.
Last update: 2024-05-21 02:32:59 UTC
README
Introduction
This package provides utilities required for signing and authenticating calls to public URLs.
Usage
Verifying and signing requests
SalesChamp\Webhooks\Authenticator::sign expects raw HTTP request body as argument in order to provide a signature used for authentication, SalesChamp\Webhooks\Authenticator::verify expects signature received in X-SalesChamp-Signature HTTP header and raw HTTP request body in order to verify the request.
Data manipulation
SalesChamp\Webhooks\Data represents a crate with documentation describing data attached to webhook requests. This class should not be created manually, but rather generated by factories. Example of such implementation can be found in SalesChamp\Webhooks\NetteBridge\DataFactory made specifically for Nette Framework.
Tests
Can be run via ./runTests.sh.
Versioning
Library follows semantic versioning. Make sure to update to tag commits accordingly.