https://github.com/jamius19/paddle-verifier
A lighweight Paddle.com webhook verification library for Java.
https://github.com/jamius19/paddle-verifier
java paddle webhook
Last synced: 5 months ago
JSON representation
A lighweight Paddle.com webhook verification library for Java.
- Host: GitHub
- URL: https://github.com/jamius19/paddle-verifier
- Owner: jamius19
- License: mit
- Created: 2020-04-11T14:56:57.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-11-04T09:38:21.000Z (over 1 year ago)
- Last Synced: 2024-12-04T09:48:58.918Z (over 1 year ago)
- Topics: java, paddle, webhook
- Language: Java
- Homepage:
- Size: 95.7 KB
- Stars: 19
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Paddle Webhook Verifier
[](https://central.sonatype.com/artifact/com.jamiussiam/paddle-verifier) [](https://codecov.io/github/jamius19/paddle-verifier) [](https://github.com/jamius19/paddle-verifier/blob/master/LICENSE)
### What is it?
A small utility library (without any external dependecies) for verifying paddle webhooks via Public key and given signature. Paddle is an online payment gateway and more details about verifying paddle webhooks can be found [on their official documentation.](https://developer.paddle.com/webhook-reference/verifying-webhooks)
### How to get it?
#### Maven
Include it in your Maven projects.
```xml
com.jamiussiam
paddle-verifier
2.2
```
#### Gradle
Include it in your Gradle projects.
```groovy
implementation 'com.jamiussiam:paddle-verifier:2.2'
```
#### Jar File
You can download the ***.jar** file from release.
### How to use it?
Using Paddle Verifier is very easy. Firstly, import it from the package.
```java
import com.jamiussiam.paddle.verifier.Verifier;
```
Then use it as shown,
```java
String publicKey;
String postBody;
Verifier verifier = new Verifier(publicKey);
boolean isValid = verifier.verifyDataWithSignature(postBody);
```
### Detailed Guide
#### Constructor Parameter
`publicKey` is quite self explanatory, it's the `String` representation of your public key. For example,
```java
String publicKey = "-----BEGIN PUBLIC KEY-----\n" +
"MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAIfVXds6Dfo+EZGFcOJPuhUverHOConA\n" +
"j51EQuVpAEhPw6PgyZCi504jxNgiGj6YVOkEJtz5C2d3mgJzsBJs6fUCAwEAAQ==\n" +
"-----END PUBLIC KEY-----\n";
```
#### Method Parameter
`postBody` is your POST data from Paddle webhook and it should be in this format,
```http request
alert_id=1688369608&balance_currency=GBP&balance_earnings=438.94&balance_fee=689.32 ....
```
It should contain `p_signature` key. The key value pairs should be separated by `&` and the post body should be [URL Encoded.](https://en.wikipedia.org/wiki/Percent-encoding) (Paddle does this by dafault)
#### Spring Boot
In spring boot, you can define the bean by,
```java
String publicKey;
@Bean
public Verifier getVerifier() {
return new Verifier(publicKey);
}
```
Then, inject it inside your `Controller` or `Component` like,
```java
@Autowired
Verifier verifier;
```
Finally, you can use it to verify incoming requests from Paddle,
```java
@PostMapping(value = "/webhook/", consumes = MediaType.APPLICATION_FORM_URLENCODED_VALUE)
private boolean webhook(HttpEntity httpEntity) {
// Get the validity staus of the request
boolean isValid = verifier.verifyDataWithSignature(httpEntity.getBody());
if (isValid) {
// ... your logic goes here
}
return isValid;
}
```