verae-zapier-app/README.md

38 lines
1.3 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# verae-zapier
Zapier Platform CLI app for Verae. Runs on **Zapiers servers**. Calls only middleware HTTPS (`MIDDLEWARE_BASE_URL`), never NATS and never `api.veraetime.net`.
**Forgejo:** https://git.georgelambert.org/marchon/verae-zapier-app
**Catalog:** https://zapier.georgelambert.org/packages/verae-zapier/README.pdf
**Sphinx API sheets:** https://zapier.georgelambert.org/sphinx/index.html
## Role
Runs on **Zapiers servers**. Calls only the middleware HTTPS API (`MIDDLEWARE_BASE_URL`), never NATS and never `api.veraetime.net` directly.
## Planned modules
| File | Purpose |
|------|---------|
| `authentication.js` | Custom API key auth → `GET /zapier/v1/auth/me` |
| `index.js` | App definition, beforeRequest, afterResponse error mapping |
| `creates/timestamp_and_wait.js` | Primary action |
| `creates/create_timestamp.js` | Async jobId action |
| `creates/verify_timestamp.js` | Verify certificate |
| `creates/batch_timestamp.js` | Batch create |
| `searches/job_status.js` | Lookup by jobId |
| `triggers/timestamp_completed.js` | REST Hook |
I/O contracts: https://zapier.georgelambert.org/docs/developer/modules/function-reference.pdf
## Env
```bash
export MIDDLEWARE_BASE_URL=https://your-middleware.example.com
```
## Gate
```bash
npm run gate:11 # from monorepo root, after Phase 11 implementation
```