API та інтеграція

Коротка інструкція

Відкрийте API у Workspace та виберіть створення ключа. Ключами керує власник компанії.
Виберіть права та строк дії й безпечно збережіть ключ. Власник компанії може знову показати його кнопкою Show key. Старі ключі, збережені лише як хеш, показати неможливо.
Зберігайте ключ на сервері інтеграції. Надсилайте запити до https://workspace.mydiagnostics.app/api/v1 із заголовком Authorization: Bearer YOUR_API_KEY.
Перевірте фільтри та сторінки на workspace.mydiagnostics.app/api/docs/. OpenAPI описує кінцеві точки та формати відповідей.

Покроково на знімках

Справжні знімки англійського інтерфейсу з демонстраційними даними. Вигляд може дещо відрізнятися залежно від мови та версії застосунку.

1. В API назвіть інтеграцію та виберіть дозволи й термін дії ключа.Збільшити знімок ↗

2. Документація містить адресу API, автентифікацію та приклади запитів.Збільшити знімок ↗

Спочатку визначте мету інтеграції

API v1 доступний у всіх тарифах MyDiagnostics. Власник компанії створює ключі на workspace.mydiagnostics.app/api/. API читає історію та деталі діагностики, результати тестів, станції й використання тарифу. Права, фільтри, сторінки та приклади описані на workspace.mydiagnostics.app/api/docs/. Специфікацію OpenAPI можна імпортувати в Postman або Swagger.

Зіставлення даних і пристроїв

Заздалегідь визначте однозначне зіставлення результатів. Продумайте роботу із серійним номером, IMEI, внутрішнім замовленням і часом тесту. Деякі показники можуть бути недоступні для конкретного пристрою. Розрізняйте відсутнє значення, незавершений тест і дійсний результат. Узгодьте також обробку повторної діагностики одного телефону, щоб пізніше вимірювання не перезаписувало попередній сервісний стан без пояснення. Перевірте зіставлення перед початком регулярної роботи.

Дані доступу та розмежування компаній

Зберігайте дані доступу інтеграції на власному сервері. Не розміщуйте їх у відкритому JavaScript, знімках екрана або звичайних вкладеннях електронної пошти. Використовуйте лише дозволи свого облікового запису, а не доступ іншої компанії. Код сполучення станції не є автоматично ключем API. Реалізуйте автентифікацію й можливе поновлення доступу за актуальною документацією. Якщо підозрюєте витік, узгодьте відкликання та заміну з відповідальним адміністратором або підтримкою.

Перевірка перед робочим запуском

Спочатку перевірте інтеграцію на невеликій контрольованій вибірці. Звірте пристрій, час, одиниці вимірювання та поведінку за помилки або тимчасової недоступності. Захистіть повторну обробку від дублікатів і ненавмисного запуску додаткової операції. Записуйте в журнали лише потрібні технічні дані без паролів і токенів. Для консультації надішліть на support@myrepair.app мету інтеграції, версію документації, час помилки та знеособлений приклад проблеми.

Кроки можуть відрізнятися залежно від версії застосунку та системи.

Усі інструкції

Потрібна допомога?

Free містить загальнодоступні інструкції; особиста технічна підтримка входить до платних тарифів. Напишіть на support@myrepair.app. Укажіть назву компанії, модель пристрою, версію системи та крок, на якому виникла проблема. Не надсилайте паролі, токени доступу чи коди сполучення.

Написати до підтримки