Inleiding tot LabCollector API- LabCollector

Zoek in de kennisbank op trefwoord

U bent hier:
← Alle onderwerpen
OVERZICHT:

API is de Application Programming Interface, een computerinterface die interacties tussen meerdere software-tussenpersonen definieert. In eenvoudige bewoordingen kunnen twee applicaties met elkaar praten. Wanneer u bijvoorbeeld een applicatie op uw mobiel gebruikt om Facebook, Instagram of de weer-app te bekijken, gebruikt u de API. Hetzelfde geldt als u gebruikt LabCollector LIMS en je wilt verbinding maken met software van derden, dan kun je verbinding maken via API.

De LabCollector Met de Web Service Application Programming Interface (API) kunnen applicaties van derden met beide communiceren LabCollector's database (modules) en LabCollector add-ons (ELN en LSM).

AgileBio biedt API voor (ze worden in onderstaande secties uitgelegd): -

  • Belangrijkste LC-API: Hiermee kunt u modulegegevens (voorbeelden..), opslag, bestanden ophalen/plaatsen... bewerken/extraheren...
  • ELN API: Dit helpt u bij het werken aan boeken/pagina's (ophalen/toevoegen), bij het uploaden van bestanden/afbeeldingen
  • LSM-API: Hiermee kunt u aan analytische / diensten werken (taken toevoegen, resultaten bijwerken, resultaten krijgen ...)
  • WF-API (Nieuw!): Dit kan helpen nieuwe workflows te activeren en de status te wijzigen

De API is gebaseerd op een Representational State Transfer (REST)-architectuur die toegang mogelijk maakt tot resources via Uniform Resource Identifier (URI) en acties daarop. 

API biedt ook beveiliging op het gebied van gegevensintegriteit. Wanneer twee applicaties bijvoorbeeld met API praten, praten ze alleen in termen van kleine pakketjes met gegevens die nodig zijn. Bijvoorbeeld wanneer u een artikel bij Amazon bestelt. U brengt gewoon de gewenste artikelen over en vervolgens worden ze bij u afgeleverd. Je komt niet het hele proces tegen van het vervaardigen van artikelen, het verpakken of transporteren, enz. Dezelfde gegevens in LabCollector is alleen zichtbaar in sommige delen (bronnen) die met behulp van API kunnen worden aangepast.

Volg deze stappen om de LabCollector API:-

1. Algemene API-instellingen

2. API gebruiken 

3. API voor LabCollector: Uniforme bronidentificatie (URI)

4. Voorbeelden van API

5. LSM-API

6. ELN API

7. Workflow-API *NIEUW

8. Probleemoplossing (foutmeldingen)

9. Annex-webservice-API

1. Algemene API-instellingen

  • Om API in te configureren LabCollector U moet uw aanvraag indienen in LabCollector.
  • Log hiervoor in op LabCollector een superbeheerder. 
    * Lees onze KB om dit te zien wat zijn superadmin-machtigingen LabCollector.
  • In het LabCollector als je inlogt ga naar BEHEERDER -> ORGANISATIE -> WEBDIENSTEN-API

  • U krijgt de onderstaande pagina te zien waar u een nieuwe applicatie kunt definiëren waarmee u verbinding wilt maken LabCollector via API.

 

  • 1. NAAM: Hier kunt u de naam van uw toepassing toevoegen. We hebben bijvoorbeeld de naam van onze add-on toegevoegd, namelijk monsterontvangst.
  • 2. STANDAARD OPERATOR: Hier kunt u de persoon invoeren die u als operator voor deze API wilt fungeren. Als u de operator hier niet toevoegt, moet u deze toevoegen bij elk verzoek dat u via de API doet.
  • 3. IP-BEPERKING: Met deze optie beschikt u over een beveiligingslaag, aangezien u hier kunt definiëren welke IP-adressen (internetprotocol) mogen werken op de API die u definieert. Houd er rekening mee dat als u “ja” kiest, het vakje voor het invoeren van het IP-adres pas verschijnt nadat u uw instelling hebt opgeslagen.
  • 4. MODULES VERBONDEN MET DEZE TOEPASSING: Er zijn standaard 12 modules aanwezig LabCollector. Afgezien hiervan kunt u ook nieuwe aangepaste add-ons maken volgens uw vereisten. Alle standaardinstellingen, aangepaste modules en add-ons zijn hier aanwezig en u kunt kiezen welke modules u met de API wilt laten communiceren.
  • 5. TOEVOEGEN: zodra u uw instellingen heeft gedefinieerd, kunt u op toevoegen klikken en uw API ziet er als volgt uit.
  • A. Nu kunt u het IP-adres toevoegen en op “Nieuw IP toevoegen” klikken.
  • B. Door op het updatepictogram te klikken, kunt u uw API-instellingen bewerken.
  • C. Dit is uw tokennummer dat kan worden gebruikt om verbinding te maken met de API. U kunt er zelfs een streepjescode voor maken en deze kopiëren door op te klikken icoon.
 NOTITIE: Opmerking: om deze functie te gebruiken, moet u Curl activeren in uw PHP-voorkeuren. Installeer in Linux het PHP-Curl-pakket. In Windows en met ons automatische installatieprogramma bewerkt u PHP.ini en verwijdert u commentaar op extensies voor Curl (extension=php_curl.dll).

2. API gebruiken 

  • De communicatiedialoog tussen externe applicaties (van derden) en LabCollector is gebaseerd op het HTTP 1.1-protocol. (*Om te controleren wat een bron is, zie bovenstaande afbeelding)

  • U kunt een bron wijzigen, lezen, maken of verwijderen met behulp van de GET, POST, PUT en DELETE methode zoals weergegeven in de bovenstaande afbeelding.
  • U kunt een wijziging aanvragen en vervolgens het antwoord op de wijziging ontvangen, zoals hieronder wordt uitgelegd.
  • We gebruikten bijvoorbeeld de POSTMAN-applicatie Gereedschap voor API en de interface ziet er als volgt uit.

  • Zoals je in de bovenstaande afbeelding kunt zien, kun je de API-URL typen (bijvoorbeeld link naar LabCollector's Strains & Cells-module) en nadat u klaar bent met de wijzigingen en op verzenden klikt, krijgt u een reactie.
    Als alles klopt en het verzoek is uitgevoerd, ziet het antwoord er in de Postman-applicatie als volgt uit.
  • 1. Hier kunt u de wijze van uw aanvraag kiezen. (GET, POST, PUT en DELETE)
  • 2. Voor een API-verzoek is een aantal specifieke HTTP/HTTPS vereist koppen.
  • 3. De ACCEPTEREN header definieert het gewenste antwoordformaat van uw verzoek, tekst/XML (standaard) of applicatie/JSON.
  • 4. De X-LC-APP-Auth header waar u uw applicatietoken plaatst, wat nodig is om uw verzoek aan de API te autoriseren.
  • 5. De X-LC-APP-tekenset header definieert de tekencodering van uw applicatie. Hiermee kan de API het antwoord terugsturen met de juiste codering en uw POST- en PUT-verzoeken correct converteren naar de LabCollector's tekencodering (ISO 8859-1).

3. API voor LabCollector: Uniforme bronidentificatie (URI)

  • Een Uniform Resource Identifier (URI) is een reeks tekens die een bepaalde bron ondubbelzinnig identificeert.

  • URL herschrijven AAN (mod_rewrite)
    Opmerking: U moet dit in uw apache-bestand doen.

    [PAD NAAR_LABCOLLECTOR]/webservice/v2/[MODULE]

  • Normale URL's:

    [PAD NAAR_LABCOLLECTOR]/webservice/v2/[MODULE]?name=[KEYWORD]
  • Voor meer informatie over de URI en hoe u deze kunt gebruiken LabCollector, Dan kunt u lees onze handleiding op LabCollector API pagina 7-17.

4. Voorbeelden van API

  • Voorbeeld van codes in C# 
    string url = _Url.Replace("{id}", txtDataID.Text); var client = nieuwe RestSharp.RestClient(url); client.Time-out = 900000; var verzoek = nieuwe RestSharp.RestRequest(); verzoek.Time-out = 900000; verzoek.Methode = Methode.GET; request.AddHeader("X-LC-APP-Auth", token); request.AddHeader("Accepteren", "text/xml"); //////////////////// IRestResponse antwoord = client.Execute(verzoek); stringresultaat = antwoord.Inhoud;
  • Voorbeeld van codes in PHP: 
    HEADERINFO ONTVANGEN VAN DE API $API_response = curl_exec($curl); curl_close($curl); echo $API_response; ?>
  • Voorbeeld API naar stuur een bestand: 
    labcollector.rar'; $file_info = getimagesize($file_path); $file_size = bestandsgrootte($file_path); $update = array( 'health_report_file[0]' => '@'.$file_path.";bestandsnaam=zz_labcollector.rar;type=applicatie/x-rar-gecomprimeerd", 'health_report_file[1]' => '@'.$file_path2.";filename=zz_labcollector2.rar;type=applicatie/x-rar-gecomprimeerd", 'upload_mode' => 'toevoegen'); $curl = curl_init(); curl_setopt($curl, CURLOPT_HTTPHEADER, array('X-LC-APP-Auth: TOKEN', 'Inhoudstype: '.$file_info['mime'])); ; curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PUT"); curl_setopt($curl, CURLOPT_POSTFIELDS, $update); , true); //OPTIONEEL -> HEADERINFO ONTVANGEN VAN DE API $API_response = curl_exec($curl_close($curl($API_response);

5. LSM-API

  • Lab Service Manager (LSM) is onze add-on voor service core/testlabs.
  • Zoals eerder uitgelegd, kunt u configureren om verbinding te maken met de LSM-add-on (door het vakje vóór add-ons aan te vinken), zoals weergegeven in sectie 1 bovenstaand.
  • U kunt de API gebruiken om de GET-methode te gebruiken om informatie te lezen/ophalen over verschillende parameters die u in een test gebruikt, zoals een monsternaam, assaystatus, batchinformatie, taak-ID, enz.
  • Gelieve onze KB over LSM-API.
  • Wilt u meer weten over de LSM API en hoe u deze kunt gebruiken? LabCollector, Dan kunt u lees onze handleiding over API pagina 18-28.

6. ELN API

  • Elektronisch laboratoriumnotitieboekje (ELN) add-on is de vervanging van een papieren laboratoriumnotitieboekje. 
  • Zoals eerder uitgelegd, kunt u configureren om verbinding te maken met de ELN add-on (door het vakje vóór add-ons aan te vinken, zoals weergegeven in sectie 1 bovenstaand.
  • U kunt de API gebruiken om de GET- en POST-methode te gebruiken om informatie over gegevens van boeken, experimenten en pagina's te lezen/ophalen.
  • Gelieve onze KB aan ELN API.
  • Om meer te weten over de ELN API en hoe u deze kunt gebruiken LabCollector, Dan kunt u lees onze handleiding op ELN API pagina 29-30.

7. Workflow-API *NIEUW

  • Workflow add-on kan worden gebruikt door instituten die een strikt stapsgewijs validatieprotocol willen volgen.
  • LabCollector biedt nu aan om verbinding te maken met de workflow-add-on met behulp van API.
  • Met behulp van de workflow-API kunt u nu een bepaalde taak uitvoeren of een knooppunt voltooien. (een knooppunt is een proces of stap in de workflow-add-on)
  • Voor meer informatie over de workflow-API en hoe u deze kunt gebruiken LabCollector, Dan kunt u lees onze handleiding over Workflow API.

8. Probleemoplossing (foutmeldingen)

9. Annex-webservice-API

  • In de bijlage worden de schone URL's beschreven die moeten worden gebruikt om goed te kunnen functioneren.
  • De bijlage beschrijft alle URI's die moeten worden gebruikt met de gerelateerde module en beschrijving en informeert u ook over de methode (PUT, POST, enz.) die daarvoor moet worden gebruikt.
  • U moet de Apache-engine inschakelen om de URI te gebruiken die in de bijlage wordt beschreven. Lees of KB verder webservice/apache-installatie.
  • Wilt u meer weten over de LSM API en hoe u deze kunt gebruiken? LabCollector, Dan kunt u lees onze handleiding over API pagina 33-37.

Gerelateerde onderwerpen: