affiliate
GET /v1/affiliate
Your affiliate account, your earnings, and the lines you can choose from.
Аутентификация
Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.
Идентификатор вашей организации
Этот эндпоинт принимает org_id в качестве параметра запроса. Оставьте его пустым, и вызов охватит все поддерево вашей аренды; передайте его, чтобы сузить область вызова до одной организации.
Идентификатор вашей организации находится на экране ключей API в вашей панели управления, рядом с самим ключом. Это один и тот же идентификатор для каждого вашего запроса.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X GET https://api.zinndigital.com/v1/affiliate \
-H "Authorization: Bearer zdk_live_…"Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
Gated on `affiliate.view`. Answers `200` with `account: null` when this organisation has not joined — "you are not an affiliate yet" is a normal state of a screen every customer can open, not an error. `totals.by_currency` is grouped by currency and deliberately **not** summed across them: adding 100 GBP to 100 EUR produces a number that is wrong in both. `plans` is served from the engine rather than hardcoded in a console, so a rate the owner changes cannot disagree with the rate a customer read before signing up.
Параметры
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
org_id (query) | string | Нет | — |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
account | AffiliateAccount | Да | — |
totals | AffiliateTotals | Да | — |
plans | AffiliateCommissionPlan[] | Да | — |
Ошибки, которые может возвращать этот эндпоинт
401 · 403 · 404