Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/j3k0/ganomede-purchases
https://github.com/j3k0/ganomede-purchases
Last synced: 24 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/j3k0/ganomede-purchases
- Owner: j3k0
- Created: 2022-01-18T15:33:22.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2022-02-04T16:13:06.000Z (almost 3 years ago)
- Last Synced: 2024-10-16T11:16:10.758Z (2 months ago)
- Language: TypeScript
- Homepage:
- Size: 172 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ganomede-purchases
Purchases API.
Relations
---------
* "PurchasesDB" (Redis) -> a cache to store the purchases for each user.
* "AuthDB" (Redis) -> to store the subscription status for each user.
* see https://github.com/j3k0/node-authdb
Configuration
-------------
Variables available for service configuration.
* `FOVEA_BILLING_SECRET_KEY` - The secret API key from Fovea.Billing
* `REDIS_PURCHASES_PORT_6379_TCP_ADDR` - IP of the PurchasesDB redis database.
* `REDIS_PURCHASES_PORT_6379_TCP_PORT` - Port of the PurchasesDB redis database.
* `REDIS_PURCHASES_TTL` - Default TTL of the PurchasesDB redis database.
* `REDIS_AUTH_PORT_6379_TCP_ADDR` - IP of the AuthDB redis
* `REDIS_AUTH_PORT_6379_TCP_PORT` - Port of the AuthDB redis
PurchasesDB
---------------
* Contains a store:
* `"purchases:fovea:user:USER_ID"` -> Purchase objects from Fovea.
API
---
## /purchases/v1/auth/:token/subscription [GET]
Status of the identified users' subscription, the one with the latest `expirationDate`.
### response [200]
A **Subscription Status** object (cf Data Types).
```json
{
"productId":"apple:monthly_subcscription",
"platform":"apple",
"purchaseId":"apple:1000000532000112",
"purchaseDate":"2019-07-29T17:14:00.000Z",
"expirationDate":"2019-07-29T17:19:00.000Z"
}
```
### implementation details
The endpoint will check in the PurchasesDB for the existance of a Purchase Collection object.
If not present, it'll fetch it and update the PurchasesDB, using Fovea's customer purchase API: https://billing.fovea.cc/documentation/api/customer-purchases/ - Cf the webhook endpoint below for more info about storing Purchases, the logic has to be the same in all aspects.
The object is then returned in JSON.
## /purchases/v1/webhooks/fovea [POST]
Receive webhook calls from Fovea. See https://billing.fovea.cc/documentation/webhook/
* Checks that the provided password matches the `FOVEA_BILLING_SECRET_KEY` configuration.
* Stores the user's "Purchase Collection" object in a Redis cache.
### reponse [200]
### implementation details
The Purchase object is stored in redis with the key `"purchases:fovea:user:USER_ID"` (replace `USER_ID` with the appropriate one).
Object stored in redis use the TTL defined by `REDIS_SUBSCRIPTIONS_TTL`.
If the purchase collection is empty, store the empty object.
Data Types
----------
As this API is heavily dependant on Fovea.Billing, the data types match very closely.
the [Fovea.Billing documentation](https://billing.fovea.cc/documentation/) is a good reference for details.
## Subscription Status
The subscription status corresponds to the "Purchase" object in Fovea.Billing. See https://billing.fovea.cc/documentation/api/customer-purchases/
Example:
```json
{
"sandbox":false,
"productId":"apple:monthly_subcscription",
"platform":"apple",
"purchaseId":"apple:1000000532000112",
"purchaseDate":"2019-07-29T17:14:00.000Z",
"expirationDate":"2019-07-29T17:19:00.000Z",
"cancelationReason":"Customer",
"renewalIntent":"Lapse"
}
```
# License
MIT.