Le check-in remplace l'intégration banking V1 (cf. CLAUDE.md → Glossaire) :
avant que la 1re relance ne parte, on demande à l'user "as-tu été payé ?"
via email, et il clique sur l'un des 2 liens publics.
Service checkin_token.ts : génération + hash SHA-256. 32 bytes random base64url, plain dans le mail, hash en DB (CheckinTask.token_hash unique).
Service checkin_scheduler.ts :
- scheduleCheckinForInvoice(invoice) : crée 1 CheckinTask à dueDate (now+1min si dueDate dans le passé). Idempotent par invoice — cancel les scheduled précédents avant.
- cancelCheckinForInvoice(invoiceId) : appelé par mark-paid pour stopper.
Job send_checkin_job.ts : worker queue 'checkins', skip si invoice paid/cancelled (no-op), construit l'URL avec le plain token (passé dans le payload du job, pas relu DB), appelle sendCheckinEmail.
mail_dispatcher.ts : sendCheckinEmail() — texte brut, destinataire = user (pas client !), 2 URLs (paid / pending), TTL 24h annoncé.
Controller CheckinController :
- GET /api/v1/checkin/:token/paid : status=answered + answer=paid + mark invoice paid (mêmes effets que POST /invoices/:id/mark-paid : rubis +1, ActivityEvent invoice_paid avec label "via check-in", cancelFutureRelances). Idempotent : 2e click → redirect "already_answered".
- GET /api/v1/checkin/:token/pending : status=answered + answer=still_pending. Les relances suivent leur cours.
- Validation : lookup hash, expiry (sentAt + 24h), redirects propres pour invalid / expired / already_answered.
Routes : nouveau group public `checkin` (PAS de middleware.auth) à côté du group auth, sous /api/v1.
Triggers branchés :
- InvoicesController.store et ImportBatchesController.validateDraft → scheduleCheckinForInvoice après création
- InvoicesController.markPaid → cancelCheckinForInvoice dans la tx
start/queue.ts : registerWorker('checkins', sendCheckinJob).
env : nouveau WEB_URL (URL du SPA pour redirects), default localhost:5173 en dev.
Bruno : nouveau dossier 08-Checkin avec doc complète du flow + 2 requêtes (paid / pending). var d'env `checkinToken` à remplir manuellement après avoir reçu l'email dans Mailpit.
48 lines
1.2 KiB
Plaintext
48 lines
1.2 KiB
Plaintext
meta {
|
|
name: 01 Respond paid
|
|
type: http
|
|
seq: 1
|
|
}
|
|
|
|
get {
|
|
url: {{baseUrl}}/api/v1/checkin/{{checkinToken}}/paid
|
|
body: none
|
|
auth: none
|
|
}
|
|
|
|
settings {
|
|
encodeUrl: false
|
|
}
|
|
|
|
tests {
|
|
test("302 redirect", function () {
|
|
expect(res.getStatus()).to.be.oneOf([302, 303, 307]);
|
|
});
|
|
test("redirect contient ?checkin=", function () {
|
|
const loc = res.getHeader("location");
|
|
expect(loc).to.match(/checkin=/);
|
|
});
|
|
}
|
|
|
|
docs {
|
|
GET /api/v1/checkin/:token/paid
|
|
|
|
L'utilisateur clique "j'ai été payé" depuis son email check-in.
|
|
Effets côté API :
|
|
- CheckinTask : status='answered', answer='paid', answered_at=now
|
|
- Invoice : status='paid', paid_at=now, rubis_earned+1
|
|
- Organization.rubis_count+1
|
|
- ActivityEvent kind=invoice_paid (label "via check-in")
|
|
- Toutes les RelanceTask scheduled de cette facture → cancelled
|
|
|
|
Idempotent : 2e click → redirect avec `?checkin=already_answered`.
|
|
|
|
Redirect SPA : `${WEB_URL}/?checkin=paid&invoice=<numero>`
|
|
|
|
Comment récupérer un `checkinToken` :
|
|
1. Crée une facture (Invoices → 04 Create) avec dueDate dans le passé
|
|
2. Attends ~1min, ouvre Mailpit http://localhost:8025
|
|
3. Copie le segment du token depuis l'URL "C'est payé" du mail
|
|
4. Pose-le dans la var d'env `checkinToken`
|
|
}
|