Команда та доступ
Запросіть когось до всього облікового запису мерчанта або до одного магазину. Використовуйте сесію входу з доступом власника мерчанта; API-ключ магазину не може керувати командою. Щоб відкрити весь свій акаунт Invoise разом із гаманцем і карткою, додайте натомість учасника акаунта.
Запросіть колегу
Section titled “Запросіть колегу”curl -X POST 'https://platform.invoise.me/api/v1/merchants/{merchant_id}/invites' \ -H 'Authorization: Bearer <session-token>' \ -H 'Idempotency-Key: <saved-unique-key>' \ -H 'Content-Type: application/json' \Використовуйте viewer для читання, developer для роботи з інтеграцією або owner для адміністрування. Задайте shop_id, щоб обмежити запрошення одним магазином. Якщо пропустити це поле або задати null, доступ надається в межах усього мерчанта.
Щоб запросити агента чи будь-кого, хто входить через гаманець, надішліть "provider":"wallet" і його EVM-адресу в subject. Він прийме запрошення після входу цим гаманцем.
Перевірте роль і область перед надсиланням. Обраний магазин має бути активним і належати цьому мерчанту; недійсний магазин не переходить у доступ в межах усього мерчанта.
Отримувач входить і приймає запрошення через POST /api/v1/invites/{id}/accept. Надішліть ключ ідемпотентності і для цього запиту. Перед прийняттям GET /api/v1/invites/{id} показує мерчанта, магазин, роль і того, хто запросив, а status — open, accepted, used, revoked, expired або unavailable. За замовчуванням запрошення діє 7 днів.
За замовчуванням у мерчанта може бути до 10 учасників і запрошень, що очікують, разом. Понад це і запрошення, і прийняття повертають 400 team_limit_reached; персонал Invoise може підняти ліміт. Див. Ліміти.
Перегляд або видалення доступу
Section titled “Перегляд або видалення доступу”| Запит | Призначення |
|---|---|
GET /api/v1/merchants/{merchant_id}/team |
список прав доступу та запрошень. |
DELETE /api/v1/merchants/{merchant_id}/invites/{id} |
відкликати запрошення, що очікує. |
DELETE /api/v1/merchants/{merchant_id}/grants/{id} |
видалити наявний доступ. |
POST /api/v1/merchants/{merchant_id}/leave |
вийти з мерчанта, до якого ви приєдналися. |
Зміни вимагають відповідної сесії власника та ключа ідемпотентності. Якщо увімкнено MFA, чутлива операція може запросити свіжий код.
Для виходу потрібна лише ваша сесія. Вийти не можна з мерчанта, який ви створили (own_merchant), його останньому власнику (last_merchant_owner) і поки якийсь його магазин платить на ваш гаманець Invoise (wallet_in_use, назви магазинів — в error.details).
Учасники акаунта
Section titled “Учасники акаунта”Учасник акаунта працює в усьому вашому акаунті Invoise: у гаманці, картці, рефералах і всіх мерчантах, якими ви володієте. Учасник команди з розділів вище отримує роль в одному мерчанті чи магазині й ніколи не бачить ваш гаманець і картку. Учасниками акаунта керують у кабінеті: Профіль → Доступ.
| Роль | Може |
|---|---|
Спостерігач (viewer) |
Бачити гаманець, картку, рефералів і ваших мерчантів. Нічого не змінює. |
Редактор (editor) |
Те саме, що спостерігач, і працювати в магазинах як developer: рахунки, адреси, API-ключі, вебхуки. Налаштування магазинів лишаються за власником. |
Власник (owner) |
Усе, що можете ви: виводити кошти, змінювати захист гаманця й автовивід, картку, налаштування магазинів і учасників акаунта. |
Спостерігач чи редактор ніколи не виводить кошти, не підписує транзакцій, не змінює захист гаманця, не випускає й не закриває картку і не керує учасниками. Співвласнику для підпису все одно потрібні код, пароль або ключ відновлення гаманця, але давайте цю роль лише тому, кому довіряєте як собі. Якщо у вашому акаунті ввімкнено 2FA, учасник підтверджує чутливі зміни власним другим фактором, тож 2FA потрібна і йому (403 account_mfa_required).
Запросити до акаунта
Section titled “Запросити до акаунта”У Профіль → Доступ натисніть Запросити, вкажіть email і оберіть роль. Запрошення діє 7 днів; повторне запрошення на той самий email подовжує його й змінює роль. В акаунті може бути до 20 учасників і запрошень разом.
Прийняти запрошення може лише користувач, який підтвердив цей email: входом за кодом, надісланим на нього, або через акаунт Google, email якого підтвердив Google. Email, введений під час реєстрації через гаманець, вважається підтвердженим лише після першого входу за кодом на цю адресу. Запрошений бачить запрошення в сповіщеннях і в Профіль → Доступ → Запрошення та натискає Прийняти або Відхилити; той, хто не має акаунта Invoise, отримує його листом. Власний мерчант учаснику не потрібен.
Перемкнутися й вийти
Section titled “Перемкнутися й вийти”Акаунти, до яких вам дали доступ, є в меню акаунта в розділі Акаунти, а Мій обліковий запис повертає до свого. На кожній сторінці чужого акаунта видно плашку з акаунтом, вашою роллю й кнопкою Повернутися до свого акаунта. У Профіль → Доступ → Чужі акаунти вони теж перелічені, з кнопкою Відкрити і кнопкою виходу з акаунта. Якщо акаунт власника заблоковано чи видалено, учасники втрачають до нього доступ.
Власник змінює роль учасника або натискає Прибрати доступ, а для запрошення, що очікує, — Відкликати запрошення. Коли учасник виходить або його прибирають, API-ключі, які він створив у ваших магазинах, відкликаються; те саме стається, коли його роль стає «Спостерігач». Про кожну зміну приходить сповіщення безпеки: перевірте, що учасник міг налаштувати, — вебхуки, учасників команди, делегата й автовивід.
API учасників акаунта
Section titled “API учасників акаунта”Кабінет надсилає ці запити з вашою сесією; API-ключ магазину для них не підходить.
| Запит | Призначення |
|---|---|
GET /api/v1/account/members |
список учасників і запрошень, status — pending, active або expired. |
POST /api/v1/account/members |
запросити: {"email":"[email protected]","role":"viewer"}. |
PATCH /api/v1/account/members/{id} |
змінити роль: {"role":"editor"}. |
DELETE /api/v1/account/members/{id} |
відкликати запрошення або прибрати учасника. |
GET /api/v1/accounts |
акаунти, де ви учасник, і запрошення вам. |
POST /api/v1/accounts/invites/{id}/accept |
прийняти запрошення. |
DELETE /api/v1/accounts/invites/{id} |
відхилити запрошення. |
DELETE /api/v1/accounts/{owner_id} |
вийти з акаунта. |
Щоб діяти в чужому акаунті, передайте X-Invoise-Account: <owner_id> — id з GET /api/v1/accounts; з ним співвласник керує й учасниками цього акаунта. Потік подій GET /api/v1/live і вивантаження export.csv, які не можуть нести заголовок, приймають натомість ?account=<owner_id>. Ваш профіль, вхід, сповіщення й участь в акаунтах заголовок не враховують. Запит поза вашою роллю повертає 403 з account_access_denied, account_read_only або account_owner_only. Помилки запрошень повертають 400: invalid_email, invalid_role, account_invite_self, account_member_exists, account_member_limit, account_member_not_found, invite_unavailable.
Заблоковані облікові записи
Section titled “Заблоковані облікові записи”Якщо персонал Invoise блокує мерчанта, його неоплачені рахунки скасовуються з причиною merchant_blocked, його депозитні адреси вимикаються, а його API-ключі перестають працювати. Учасники бачать причину в кабінеті.
Заблокований користувач і далі може увійти, переглянути гаманець, картку й сповіщення, вивести кошти з гаманця й закрити картку. Інші запити повертають 403 account_disabled із причиною в error.details.
Сповіщення
Section titled “Сповіщення”Invoise надсилає сповіщення про обліковий запис, платежі й безпеку — про надходження, виведення з гаманця, зміни захисту, операції з карткою та запрошення — на email і, якщо ви його підключили, у Telegram. Канали обираються в профілі.
Експорт історії платежів
Section titled “Експорт історії платежів”Завантажте GET /api/v1/shops/{shop_id}/export.csv з доступом на читання магазину. Використовуйте це для бухгалтерських експортів, а не як сповіщення про платіж.