Developer API
A read-only API. It returns exactly what the key’s owner sees on their own screens — the same rows, from the same database, under the same access policies. Nothing here changes anything.
Creating a key
- Sign in to the dashboard with your account.
- In the side menu: My account (the dashboard is in Hebrew for now — it is the item with the person icon).
- On the API keys card: choose what the key may read, and create it.
- Copy the key at once — it is shown only one time.
A paid add-on
API access is a paid add-on, for stores and affiliates alike. The dashboard and the CSV export stay free, always — every click, conversion and commission can be seen and saved as a file without paying. What is added is the automated pipeline.
There are no defined plans yet. Talk to us and we will arrange it. Until it is switched on, an existing key returns an empty list — not an error.
Authentication
Every request carries a key in the header Authorization: Bearer afp_live_…. The key is created on the account screen and shown only once — we keep only a hash of it, so we cannot show it again either.
A key belongs to a person, not to a store and not to an affiliate. What it can read follows from what that person can read in the system at that moment: someone who manages two stores gets both on the same key, and someone who is both an affiliate and a store owner can select resources from both sides.
The selection at creation time only narrows. It widens nothing: a resource selected for someone who is not supposed to see it returns an empty list, never somebody else’s data.
Example
curl -H "Authorization: Bearer $API_KEY" \ "https://affix.co.il/api/v1/store-orders?days=30&limit=100"
The response is { data: [...], meta: { resource, count, limit, from, to } }. count is the number of rows in this response, not the total.
Parameters
fromandto— an inclusive range, in the formatyyyy-MM-dd. Both together, otherwise they are ignored.days— 7, 30 or 90 days back including today. Default: 30.limit— between 1 and 1000, default 100. A value out of range is clamped, not rejected.
An unusual request does not return an error but falls back to the default: a query string edited by hand should not bring an integration down.
Rate limit
120 requests per minute, counted per person and not per key — so two keys of the same person share one allowance. Exceeding it returns 429 with Retry-After.
Resources
Five, and they are exactly the resources that can be downloaded as CSV from the screens. The columns were chosen one by one: pseudonymous identifiers and data nobody asked for simply do not leave through here.
GET /api/v1/affiliate-sales
המרות
For: Affiliate · filtered by occurred_at
occurred_atdate and time (ISO 8601)store_nametextorder_idtextprogram_nametextevent_typetext — purchase | lead | signup | trial | subscription | renewal | booking | installtotaldecimal numberrefunded_amountdecimal numbercurrencytextattribution_reasontextcoupon_codetextcommission_amountdecimal numbercommission_adjustmentsdecimal numbercommission_statustext — pending | approved | rejected | reversed | paid
GET /api/v1/affiliate-commissions
לוח-שחרור
For: Affiliate · no date filter
release_ondate (yyyy-MM-dd)kindtextcommissionsintegeramountdecimal number
GET /api/v1/store-orders
הזמנות
For: Store owner · Operator · filtered by occurred_at
occurred_atdate and time (ISO 8601)order_idtexttotaldecimal numbercurrencytextrefunded_amountdecimal numberaffiliate_nametextprogram_nametextcoupon_codetextattribution_reasontextcommission_amountdecimal numbercommission_adjustmentsdecimal numbercommission_statustext
GET /api/v1/store-partners
שותפים
For: Store owner · Operator · no date filter
display_nametextref_codetextaffiliate_statustext — pending | approved | rejected | paused | terminatedclicksintegerordersintegerrevenuedecimal numbercommission_pendingdecimal numbercommission_approveddecimal numbercommission_paiddecimal number
GET /api/v1/operator-commissions
עמלות
For: Operator · filtered by created_at
order_idtextstore_nametextaffiliate_nametextaffiliate_reftextamountdecimal numberadjustmentsdecimal numbercurrencytextstatustext — pending | approved | rejected | reversed | paidlocked_untildate and time (ISO 8601)
What is not here, on purpose
There is no postback and no outgoing webhook. The platform does not send anyone’s data to an external destination on its own initiative — whoever wants data asks for it. This is a decision about what may flow out, not a technical limitation.
There is no writing through the API either. Measurement comes in through the pixel and the webhooks, which keep the two measurement layers separate; an action that changes money is done on a screen, with the person responsible for it signed in.