affiliate

POST /v1/affiliate

Join the affiliate programme.

Όλα τα τελικά σημεία affiliate

Πισtoποίηση

Στείλτε ένα κλειδί API ως διακριτικό φορέα (bearer token). Αυτό το τελικό σημείο δεν ορίζει μια συγκεκριμένη άδεια στην προδιαγραφή, οπότε δώστε στο κλειδί σας τα ελάχιστα δυνατά δικαιώματα και ελέγξτε την απόκριση αντί να κάνετε υποθέσεις.

Πού μπαίνει το αναγνωριστικό του οργανισμού σας

Αυτό το τελικό σημείο δέχεται την παράμετρο org_id ως παράμετρο ερωτήματος. Παραλείψτε την και η κλήση καλύπτει ολόκληρο το υποδέντρο μίσθωσής σας· στείλτε την για να περιορίσετε την κλήση σε έναν οργανισμό.

Το αναγνωριστικό του οργανισμού σας βρίσκεται στην οθόνη των κλειδιών API στον πίνακα ελέγχου σας, δίπλα στο ίδιο το κλειδί. Είναι το ίδιο αναγνωριστικό σε κάθε κλήση που πραγματοποιείτε.

Δοκιμάστε το

Ατικatastήstε ό,τι βρίskεtai μέσα σe γώniaδeς μe τis δikές sas timές, kai to placeholder klεidioύ μe éna klεidi apó ton pinaka ελέgchou sas.

curl -X POST https://api.zinndigital.com/v1/affiliate \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "commission_plan": <string<recurring_12m, lifetime>>, "payout_destination": <string<wallet, cash>>, "accept_terms": <boolean> }'

Συνδεθήκατε; Η κονσόλα API στον πίνακα ελέγχου σας συμπληρώνει το πραγματικό αναγνωριστικό του οργανισμού σας και το δικό σας κλειδί, και εκτελεί το αίτημα στο ζωντανό API, ώστε να μπορείτε να δείτε την πραγματική απόκριση. Ανοίξτε αυτό το τελικό σημείο στην κονσόλα API

Λεπτομέρειες

Gated on `affiliate.manage`. The account lands `pending` and accrues nothing until staff approve it — otherwise the programme is an open invitation to self-refer at scale. Choosing cash payouts sets `kyc_state` to `required`; wallet credit needs no verification because the money never leaves the platform.

Παράμετροι

ΌνομαΤύpοςΥποχρεωτικόΤι είναι
org_id (query)stringΌχι

Σώμα αίτησης

ΌνομαΤύpοςΥποχρεωτικόΤι είναι
commission_planstring<recurring_12m, lifetime>Ναι
payout_destinationstring<wallet, cash>Ναι
accept_termsbooleanΝαιMust be `true`. An affiliate agreement is a contract about money, so acceptance is recorded explicitly rather than assumed.

Απάντηση

ΌνομαΤύpοςΥποχρεωτικόΤι είναι
idstringΝαι
org_idstringΝαι
statestring<pending, approved, rejected, suspended>Ναι
codestringΝαιThe referral code. Its alphabet excludes the characters people transcribe wrongly (`0`/`O`, `1`/`I`/`l`), because it is read aloud and typed off a slide.
referral_urlstringΝαιThe link to share — the public site with `?ref=CODE`.
commission_planstring<recurring_12m, lifetime>ΝαιThe line **new** referrals will be created on. Changing it never affects customers already referred.
payout_destinationstring<wallet, cash>Ναι
kyc_statestring<not_required, required, submitted, verified, rejected>Ναι
review_notestringΌχι
terms_accepted_atstringΌχι
applied_atstringΌχι

Σφάλματα που μπορεί να επιστρέψει αυτό το τελικό σημείο

401 · 403 · 409 · 422