api-referencePOST
Automatische tracking beschikbaar
Gebruik je Stripe, LemonSqueezy of Polar, dan heb je dit endpoint niet nodig. Betalingen worden automatisch gevolgd zodra je betaalprovider is gekoppeld.POST
https://analytics.flowsery.com/analytics/api/v1/paymentsRegistreer een betaling en wijs omzet toe. amount is verplicht; stuur transactionId en visitorUid of sessionUid mee als je die hebt.
Bearer-token (werkruimtetoken of website-API-sleutel)
Werkruimtetokens hebben een websiteselector nodig
Werkruimte-API-tokens hebben toegang tot elke website in de werkruimte. GeefwebsiteId of domain mee, zodat Flowsery weet welke website je wilt opvragen of wijzigen. Website-API-sleutels horen al bij één website, dus daar kun je de selector weglaten.Websiteselector
| Parameter | Type | Beschrijving |
|---|---|---|
websiteId | string | Website-ID om te gebruiken met een werkruimte-API-token. Neem dit veld op in de JSON-body, tenzij je domain meegeeft. Laat weg als je authenticeert met een website-API-sleutel. |
domain | string | Websitedomein om te gebruiken met een werkruimte-API-token als er geen websiteId is opgegeven. Neem dit veld op in de JSON-body. Laat weg als je authenticeert met een website-API-sleutel. |
Request-body
| Parameter | Type | Beschrijving |
|---|---|---|
amountVERPLICHT | number | Verplicht. Bedrag in hele valuta-eenheden, bijv. 29.99. Met isRefund het terugbetaalde bedrag. 0 registreert een free_trial-goal in plaats van een payment-goal. |
currency | string | ISO 4217-code zoals "USD", "EUR" of "GBP". Standaard "USD" als je dit weglaat, niet de valuta van de website. |
transactionId | string | Je eigen betalings-ID. Die moet uniek zijn: een herhaalde ID wordt geweigerd met 409 Conflict, niet ontdubbeld. Stuur hem opnieuw met isRefund om die betaling als terugbetaald te markeren, en gebruik hem om de betaling later te verwijderen. |
visitorUid | string | Optionele Flowsery-bezoekers-ID, meestal afkomstig uit de cookie _fs_vid in je eigen backend. |
sessionUid | string | Optionele Flowsery-sessie-ID, meestal afkomstig uit de cookie _fs_sid. |
email | string | E-mailadres van de klant. |
name | string | Naam van de klant. |
customerId | string | Klant-ID bij je betaalprovider. |
isRenewal | boolean | Zet op true voor terugkerende betalingen. Verlengingen tellen als omzet, maar slaan de automatische payment-goal over. Standaard false. |
isRefund | boolean | Zet op true om een terugbetaling te registreren. Met een bestaande transactionId wordt het terugbetaalde bedrag van die betaling bijgewerkt in plaats van een nieuw record toe te voegen. Standaard false. |
timestamp | string | Tijdstip van de betaling in ISO 8601, om oude data aan te vullen. Standaard nu. |
De payload bij succes bevat alleen een bevestigingsbericht.
Fouten
Een verzoek zonder amount geeft 400 Bad Request. Een transactionId die al voor deze website is geregistreerd, geeft 409 Conflict, tenzij isRefund true is.Voorbeeldverzoek (Node.js)
const handler = async (req, res) => {
const _fs_vid = req.cookies._fs_vid;
const _fs_sid = req.cookies._fs_sid;
const response = await fetch(
"https://analytics.flowsery.com/analytics/api/v1/payments",
{
method: "POST",
headers: {
Authorization: `Bearer ${FLOWSERY_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
websiteId: process.env.FLOWSERY_WEBSITE_ID,
amount: 29.99,
currency: "USD",
transactionId: "payment_456",
visitorUid: _fs_vid,
sessionUid: _fs_sid,
email: "buyer@example.com",
}),
}
);
res.status(200).send("Payment tracked");
};200
{
"status": "success",
"data": [{
"message": "Payment recorded successfully"
}]
}