Einbindung in Drittsysteme

Sie können CareLit über die API-Schnittstelle in Drittsysteme einbinden. Die Einbdindung erfolgt über die API-Schnittstelle von CareLit. Diese können Sie über einen einfachen HTML-Code aufrufen. Die API erreichen Sie unter der Adresse https://app.carelit.de/app/suche_api.php
Um die API nutzen zu können, benötigen Sie einen API-Key. Ihr API-Key lautet

91391387918371MTAwMDAwMQ==njdqwljh28731ns87 

Bitte geben Sie den API-Key nicht an Dritte weiter. Er ist ausschließlich in Kombination mit Ihrer Kundennummer 1000001 gültig.

Aufruf der API

Um eine Suche über die API durchzuführen, stehen folgende Parameter zur Verfügung:

• query: Ihre Suchanfrage
• apikey: Ihr API-Key
• cust_id: Ihre Kundennummer
• subid: Ihre Kundennummer bzw. Recherche-ID
• dir: Sortierreihenfolge. Mögliche Optionen: ASC, DESC
• sort: Sortiere nach. Mögliche Optionen: DOKUMENT_nr (Reihenfolge der Dokumente), AUTOR (Erstautor*in), TITEL (Titel)
• todo: Auftrag. Keine Optionen. Wert: suche
• apimode: Ausgabeformat. Keine Optionen. Wert: api
• mode: Ausgabeformat. Mögliche Optionen: html_short (Trefferliste kurz), html_long (umfangreiche Liste), json (JSON-Data).

Ein möglicher API-Auruf sieht folgendermaßen aus: Suche nach dem Begriff Pflege:

https://app.carelit.de/app/suche_api.php?apikey=91391387918371MTAwMDAwMQ==njdqwljh28731ns87&cust_id=1000001&subid=1000001&sort=DOKUMENT_nr&dir=DESC&todo=suche&apimode=api&query=pflege&mode=html_short

Die API gibt anschließend 20 Treffer für Ihre Suchanfrage aus. Sie können für die Ausgabe unterschiedliche Formate wählen:

• html_short: Ausgabe der Treffer als einfache (kurze) Liste (Autor*in, Titel, Heft, Ausgabe)
• html_long: Ausgabe der Treffer um Suchmaschinenformat (Autor*in, Titel, Heft, Ausgabe, Asbtract, Link, Suchformular)
• json: Ausgabe als json-Datei

Einbindung von html-Code in Drittsysteme (z.B. moodle)

Sie können in Ihr Content-Management-System eine Suchmaske von CareLit einbinden. Hierfür müssen Sie den folgenden HTML-Code in Ihr System einbinden:

<form action="https://app.carelit.de/app/suche_api.php" method="get">
    <input type="hidden" name="apikey" id="apikey" value="91391387918371MTAwMDAwMQ==njdqwljh28731ns87">
    <input type="hidden" name="cust_id" id="cust_id" value="{{cust_id.value}}">
    <input type="hidden" name="subid" id="subid" value="{{cust_id.value}}">
    <input type="hidden" name="sort" id="sort" value="DOKUMENT_nr">
    <input type="hidden" name="dir" id="dir" value="DESC">
    <input type="hidden" name="todo" id="todo" value="suche">
    <input type="hidden" name="apimode" id="apimode" value="api">
    
    <label for="query">Search term:</label>
    <input type="text" name="query" id="query" placeholder="Enter search term">
    
    <label for="mode">Output format:</label>
    <select id="mode" name="mode">
        <option value="html_short">Compact</option>
        <option value="html_long">Detailed</option>
        <option value="json">JSON</option>
    </select>
    
    <input type="submit" value="Search">
</form>

Sie können den HTML-Code an Ihre Bedürfnisse anpassen (z.B. Ergebnisse in einem neuen Fenster öffnen etc.)