zappier-customer-service/README.md

23 lines
1.1 KiB
Markdown

# zappier-customer-service
Department API for **customer-service credit additions** and **review** of credits, balances, usage, and payments. Internally uses **NATS** `verae.billing.*` (account-balance). HTTP fallback to account-balance then zappier-edge.
**Forgejo:** https://git.georgelambert.org/marchon/zappier-customer-service
**Catalog:** https://zapier.georgelambert.org/packages/zappier-customer-service/README.pdf
**Plugs into:** zappier-edge admin (`x-admin-key`) at `ZAPPIER_ADMIN_URL` (default `http://127.0.0.1:3000`).
```bash
PORT=3011 ZAPPIER_ADMIN_URL=http://127.0.0.1:3000 node src/server.js
curl -X POST http://127.0.0.1:3011/credits -H 'content-type: application/json' \
-d '{"customerId":"cust_1","cents":500,"reason":"goodwill","agent":"cs-anna"}'
```
| Route | Job |
|-------|-----|
| `GET /` | Staff review UI |
| `GET /health` | `{ ok, role }` |
| `POST /credits` | Add/subtract prepaid cents (NATS `balance.adjust`) |
| `GET /credits?customerId=` | Ledger |
| `GET /review/:customerId` | Full statement (balance, credits, usage, payments) |
Talks to NATS `verae.billing.*` internally. Never talks to Zapier cloud.