Der ORCID Die Such-API verwendet die SOLR-Syntax. Alle in SOLR 3.6 verfügbaren Abfragesyntaxen werden unterstützt, einschließlich Lucene mit Solr-Erweiterungen (Default), DisMax und Extended Dismax.
Zur Nutzung benötigen Sie ein „/read-public“-Zugriffstoken. Sobald Sie Ihr Suchtoken erhalten haben, erstellen Sie Ihre Basissuch-URL:
Art der Anmeldeinformationen: | Öffentliche API | Mitglieder-API |
Ressourcen-URL: | Sandbox: https://pub.sandbox.orcid.org Produktion: https://pub.orcid.org | Sandbox: https://api.sandbox.orcid.org Produktion: https://api.orcid.org |
API-Version: | v3.0 | |
Endpunkt suchen | /search/?=[Abfrage] |
Ein Beispielaufruf zur Suche nach „orcid“ mit dem Token in der öffentlichen Sandbox-API mit den im XML-Format zurückgegebenen Ergebnissen lautet:
Method: GET Content-type: application/vnd.orcid+xmlnAuthorization type and Access token: Bearer [stored access token]URL: https://pub.sandbox.orcid.org/v3.0/search/?q=orcid
Die Ergebnisse geben die Anzahl der gefundenen Ergebnisse an (num-found) und zeigen standardmäßig die ersten 1000 Ergebnisse an:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<search:search num-found="385" xmlns:search="https://www.orcid.org/ns/search" xmlns:common="https://www.orcid.org/ns/common">
<search:result>
<common:orcid-identifier>
<common:uri>https://sandbox.orcid.org/0000-0001-2345-6789</common:uri>
<common:path>/0000-0001-2345-6789</common:path>
<common:host>sandbox.orcid.org</common:host>
</common:orcid-identifier>
</search:result>
[...]
</search:search>
Ein Beispiel für eine einfache Suche in der öffentlichen Sandbox-API mit Ergebnissen, die im JSON-Format zurückgegeben werden:
Method: GET
Content-type: application/vnd.orcid+json
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.sandbox.orcid.org/v3.0/search/?q=newman
Die Suche gibt nur die Einzelperson zurück ORCID IDs von Datensätzen mit öffentlichen Daten, die mit der Suche übereinstimmen. Um weitere Informationen über das Ergebnis zu erhalten, rufen Sie an, um die zu lesen ORCID direkt aufnehmen.
Weitere Informationen finden Sie auf unserer Tutorial zur Such-API.