Введення в LabCollector API - LabCollector

Пошук у базі знань за ключовими словами

Ти тут:
← Усі теми
РЕЗЮМЕ:

API — це інтерфейс прикладного програмування, обчислювальний інтерфейс, який визначає взаємодію між кількома програмними посередниками. Простими словами, це дозволяє двом програмам спілкуватися одна з одною. Наприклад, коли ви використовуєте будь-яку програму на своєму мобільному телефоні для перегляду Facebook, Instagram або програми погоди, ви використовуєте API. Аналогічно, якщо ви використовуєте LabCollector LIMS і ви хочете підключитися до стороннього програмного забезпечення, ви можете підключитися через API.

Команда LabCollector Інтерфейс програмування веб-служб (API) дозволяє стороннім програмам взаємодіяти з обома LabCollectorбаза даних (модулі) і LabCollector доповнення (ELN і LSM).

AgileBio пропонує API для (вони пояснюються в розділах нижче):-

  • Основний API LC: за допомогою цього ви можете працювати/добувати дані модулів (зразки..), зберігати, отримувати/розміщувати файли…
  • ELN API: Це допоможе вам працювати з книгами/сторінками (отримувати/додавати), завантажувати файли/зображення
  • API LSM: за допомогою цього ви можете працювати над аналітикою / послугами (додавати вакансії, оновлювати результати, отримувати результати…)
  • WF API (Новинка!): Це може допомогти запустити нові робочі процеси, змінити статус

API базується на архітектурі Representational State Transfer (REST), що дозволяє доступ до ресурси через уніфікований ідентифікатор ресурсу (URI) і дії з ними. 

API також забезпечує безпеку з точки зору цілісності даних. Наприклад, коли дві програми спілкуються за допомогою API, вони спілкуються лише з точки зору невеликих пакетів даних, які є необхідними. Наприклад, коли ви замовляєте товар на Amazon. Ви просто доставляєте потрібні речі, а потім їх доставляють вам. Ви не стикаєтеся з усім процесом виготовлення, пакування чи транспортування товару тощо. Ті самі дані в LabCollector видимий лише в деяких частинах (ресурсах), які можна змінювати за допомогою API.

Виконайте ці кроки, щоб налаштувати LabCollector API: -

1. Загальні налаштування API

2. Як користуватися API 

3. API для LabCollector: Уніфікований ідентифікатор ресурсу (URI)

4. Приклади API

5. API LSM

6. ELN API

7. API робочого процесу * НОВИЙ

8. Усунення несправностей (повідомлення про помилки)

9. Додаток-API веб-сервісу

1. Загальні налаштування API

  • Щоб налаштувати API в LabCollector ви повинні оголосити свою заявку в LabCollector.
  • Для цього увійдіть у систему LabCollector як суперадміністратор. 
    * Будь ласка, прочитайте наш KB, щоб побачити що таке дозволи суперадміністратора LabCollector.
  • У LabCollector коли ви входите, перейдіть до ADMIN -> НАСТРОЙКА -> API ВЕБ-СЕРВІСІВ

  • Ви побачите сторінку нижче, де ви можете визначити нову програму, до якої ви хочете підключитися LabCollector через API.

 

  • 1. ІМ'Я: Тут ви можете додати назву вашої програми. Наприклад, ми додали назву нашого доповнення, яке є отриманням зразків.
  • 2. ОПЕРАТОР ЗА ПРОМОВЧАННЯМ: Тут ви можете ввести особу, яку ви хочете зробити оператором цього API. Якщо ви не додасте оператор тут, вам доведеться додавати його під час кожного запиту, який ви будете робити через API.
  • 3. ОБМЕЖЕННЯ IP: Цей параметр надає вам рівень безпеки, оскільки тут ви можете визначити, яким IP-адресам (протоколу Інтернету) дозволено працювати в API, який ви визначаєте. Пам’ятайте, що якщо ви виберете «так», поле для введення IP-адреси з’явиться лише після того, як ви збережете налаштування.
  • 4. МОДУЛІ, ПІД’ЄДНАНІ ДО ЦІЄЇ ПРОГРАМИ: За замовчуванням присутні 12 модулів LabCollector. Окрім цього, ви також можете створювати нові спеціальні доповнення відповідно до ваших вимог. Усі модулі за замовчуванням і спеціальні модулі, а також додаткові модулі будуть присутні тут, і ви можете вибрати, які модулі ви хочете взаємодіяти з API.
  • 5. ДОДАТИ: коли ви визначили свої налаштування, ви можете натиснути «додати», і ваш API виглядатиме так, як показано нижче.
  • A. Тепер ви можете додати IP-адресу та натиснути «Додати нову IP».
  • B. Натисніть піктограму оновлення, щоб змінити налаштування API.
  • C. Це ваш номер токена, який можна використовувати для підключення до API. Ви навіть можете створити для нього штрих-код і скопіювати його, натиснувши на значок.
 ПРИМІТКА: Примітка: щоб використовувати цю функцію, вам потрібно активувати Curl у ваших налаштуваннях PHP. У Linux встановіть пакет PHP-Curl. У Windows і за допомогою нашого автоматичного інсталятора відредагуйте PHP.ini та розкоментуйте розширення для Curl (extension=php_curl.dll).

2. Як користуватися API 

  • Діалог зв’язку між віддаленими (сторонніми) програмами та LabCollector базується на протоколі HTTP 1.1. (* Щоб перевірити, що це за ресурс, перегляньте зображення вище)

  • Ви можете змінювати, читати, створювати або видаляти ресурс за допомогою GET, POST, PUT і DELETE метод як показано на зображенні вище.
  • Ви можете подати запит на модифікацію, а потім отримати відповідь на модифікацію, як описано нижче.
  • Для прикладу ми використали Додаток ЛИСТОВАР Інструмент для API, а інтерфейс виглядає так, як показано нижче.

  • Як ви бачите на зображенні вище, ви можете ввести URL-адресу API (наприклад, посилання на LabCollectorмодуль Strains & Cells) і після завершення змін і натискання кнопки «Надіслати» ви отримаєте відповідь.
    Якщо все правильно і запит виконано, відповідь у додатку Postman виглядатиме так, як показано нижче.
  • 1. Тут ви можете вибрати спосіб вашого запиту. (GET, POST, PUT і DELETE)
  • 2. Для запиту до API потрібен певний HTTP/HTTPS заголовки.
  • 3. Команда Прийняти заголовок визначає бажаний формат відповіді вашого запиту, текст/XML (за замовчуванням) або додаток/JSON.
  • 4. Команда X-LC-APP-Auth заголовок, де ви розміщуєте свій маркер програми, необхідний для авторизації вашого запиту до API.
  • 5. Команда X-LC-APP-Charset заголовок визначає кодування символів вашої програми. Це дозволяє API надсилати відповідь із відповідним кодуванням і правильно перетворювати ваші запити POST і PUT на LabCollectorкодування символів (ISO 8859-1).

3. API для LabCollector: Уніфікований ідентифікатор ресурсу (URI)

  • Уніфікований ідентифікатор ресурсу (URI) — це рядок символів, який однозначно ідентифікує певний ресурс.

  • Перезапис URL-адреси УВІМКНЕНО (mod_rewrite)
    Примітка: Ви повинні зробити це у своєму файлі apache.

    [PATH_TO_LABCOLLECTOR]/webservice/v2/[МОДУЛЬ]

  • Звичайні URL-адреси:

    [PATH_TO_LABCOLLECTOR]/webservice/v2/[МОДУЛЬ]?name=[КЛЮЧОВЕ СЛОВО]
  • Щоб дізнатися більше про URI та як його використовувати LabCollector, будь ласка прочитайте наш посібник далі LabCollector API сторінка 7-17.

4. Приклади API

  • Приклад кодів в C# 
    string url = _Url.Replace("{id}", txtDataID.Text); var client = new RestSharp.RestClient(url); client.Timeout = 900000; var request = new RestSharp.RestRequest(); request.Timeout = 900000; request.Method = Method.GET; request.AddHeader("X-LC-APP-Auth", маркер); request.AddHeader("Прийняти", "текст/xml"); //////////////////// Відповідь IRestResponse = client.Execute(request); string result = response.Content;
  • Приклад кодів в PHP: 
    ОТРИМАТИ ІНФОРМАЦІЮ ЗАГОЛОВКА З API $API_response = curl_exec($curl); curl_close($curl); echo $API_response; ?>
  • Приклад API до відправити файл: 
    labcollector.rar'; $file_info = getimagesize($file_path); $file_size = розмір файлу($file_path); $update = array( 'health_report_file[0]' => '@'.$file_path.";filename=zz_labcollector.rar;type=application/x-rar-compressed", 'health_report_file[1]' => '@'.$file_path2.";filename=zz_labcollector2.rar;type=application/x-rar-compressed", 'upload_mode' => 'add' ); $curl = curl_init(); curl_setopt($curl, CURLOPT_HTTPHEADER, array('X-LC-APP-Auth: TOKEN', '.$file_info['mime'])); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); curl_setopt($curl, CURLOPT_POST, true) curl_setopt($curl, CURLOPT_TIMEOUT, $update); curl_setopt($curl, CURLO). PT_HEADER , істина);

5. API LSM

  • Lab Service Manager (LSM) — це наш додаток для базових/тестових лабораторій.
  • Як пояснювалося раніше, ви можете налаштувати підключення до надбудови LSM (поставивши прапорець перед надбудовами), як показано в розділ 1 вище.
  • Ви можете використовувати API для використання методу GET для читання/отримання інформації про різні параметри, які ви використовуєте в тесті, як-от назва зразка, статус аналізу, інформація про партію, ідентифікатор завдання тощо,
  • Будь ласка наш KB про LSM API.
  • Щоб дізнатися більше про API LSM і як його використовувати LabCollector, будь ласка прочитайте наш посібник з API сторінка 18-28.

6. ELN API

  • Електронний лабораторний зошит (ELN) доповнення є заміною паперового лабораторного зошита. 
  • Як пояснювалося раніше, ви можете налаштувати підключення до ELN надбудова (поставивши прапорець навпроти надбудов, як показано в розділ 1 вище.
  • Ви можете використовувати API для використання методів GET і POST для читання/отримання інформації про дані книг, експериментів і сторінок.
  • Будь ласка наш КБ увімкнено ELN API.
  • Щоб дізнатися більше про ELN API та способи його використання LabCollector, будь ласка прочитайте наш посібник далі ELN API сторінка 29-30.

7. API робочого процесу * НОВИЙ

  • Інститути, які бажають дотримуватися суворого покрокового протоколу перевірки, можуть використовувати доповнення робочого процесу.
  • LabCollector тепер пропонує підключитися до надбудови робочого процесу за допомогою API.
  • За допомогою API робочого процесу тепер ви можете виконати завдання або завершити вузол. (вузол — це процес або крок у надбудові робочого процесу)
  • Щоб дізнатися більше про API робочого процесу та як його використовувати LabCollector, будь ласка прочитайте наш посібник із Workflow API.

8. Усунення несправностей (повідомлення про помилки)

9. Annex-Web service API

  • У додатку описано чисті URL-адреси, які слід використовувати для належного функціонування.
  • У додатку описано всі URI, які слід використовувати з пов’язаним модулем і описом, а також інформує вас про метод (PUT, POST тощо), який слід використовувати для цього.
  • Вам потрібно ввімкнути механізм Apache для використання URI, описаного в Додатку. Прочитати або KB далі налаштування webservice/apache.
  • Щоб дізнатися більше про API LSM і як його використовувати LabCollector, будь ласка прочитайте наш посібник з API сторінка 33-37.

Схожі теми: