Hilfe

$ curl -s [-X GET|POST|PUT|HEADER] https://www.oa-deepgreen.de/api/v1/...

POST /validate?api_key=<api_key>
Content-Type: application/json

[Incoming Notification JSON]

POST /notification?api_key=<api_key>
Content-Type: multipart/form-data; boundary=FulltextBoundary

--FulltextBoundary

Content-Disposition: form-data; name="metadata"
Content-Type: application/json

[Incoming Notification JSON]

--FulltextBoundary

Content-Disposition: form-data; name="content"
Content-Type: application/zip

[Package]

--FulltextBoundary--

GET /routed[?<params>]

GET /routed/<repo_id>[?<params>]

GET /notification/<notification_id>

POST /config?api_key=<api_key>
Content-Type: application/json; charset=utf-8

[New (overwriting!) match config settings JSON]

GET /config?api_key=<api_key>

#! /usr/bin/env bash

host_url="https://www.oa-deepgreen.de"

if [ $# -ge 2 ]; then
  api_key=$1
  zip_file=$2
else
  echo "usage: `basename $0` {api-key} {zip-file}"
  exit -1
fi

curl=`which curl`
zipgrep=`which zipgrep`
wc=`which wc`

pkg_fmt="https://datahub.deepgreen.org/FilesAndJATS"
has_xml=`${zipgrep} "DOCTYPE article" ${zip_file} | ${wc} -l`

if [ ${has_xml} -eq 1 ]; then
  is_jrnl=`${zipgrep} "//NLM//DTD Journal " ${zip_file} | ${wc} -l`
  is_jats=`${zipgrep} "//NLM//DTD JATS " ${zip_file} | ${wc} -l`
  is_rsc=`${zipgrep} "//RSC//DTD RSC " ${zip_file} | ${wc} -l`
  if [ ${is_jrnl} -eq 1 ]; then
    pkg_fmt="https://datahub.deepgreen.org/FilesAndJATS"
  elif [ ${is_jats} -eq 1 ]; then
    pkg_fmt="https://datahub.deepgreen.org/FilesAndJATS"
  elif [ ${is_rsc} -eq 1 ]; then
    pkg_fmt="https://datahub.deepgreen.org/FilesAndRSC"
  else
    echo "error: no valid .xml (JATS or RSC) in zip archive found: stop."
    exit -2
  fi
else
  echo "error: no valid (or too many?!) .xml (JATS xor RSC) in zip archive found: stop."
  exit -3
fi

echo "`basename $0`: packaging format in zip archive found:"
echo "`basename $0`: ${pkg_fmt}"

${curl} -i -k -s -XPOST "${host_url}/api/v1/validate?api_key=${api_key}" -F "content=@${zip_file};type=application/zip" -F "metadata=@-;type=application/json" <<EOF
{
  "content" : {
     "packaging_format" : "${pkg_fmt}"
  }
}
EOF

echo

#! /usr/bin/env bash

host_url="https://www.oa-deepgreen.de"

if [ $# -ge 2 ]; then
  api_key=$1
  zip_file=$2
else
  echo "usage: `basename $0` {api-key} {zip-file}"
  exit -1
fi

curl=`which curl`
zipgrep=`which zipgrep`
wc=`which wc`

pkg_fmt="https://datahub.deepgreen.org/FilesAndJATS"
has_xml=`${zipgrep} "DOCTYPE article" ${zip_file} | ${wc} -l`

if [ ${has_xml} -eq 1 ]; then
  is_jrnl=`${zipgrep} "//NLM//DTD Journal " ${zip_file} | ${wc} -l`
  is_jats=`${zipgrep} "//NLM//DTD JATS " ${zip_file} | ${wc} -l`
  is_rsc=`${zipgrep} "//RSC//DTD RSC " ${zip_file} | ${wc} -l`
  if [ ${is_jrnl} -eq 1 ]; then
    pkg_fmt="https://datahub.deepgreen.org/FilesAndJATS"
  elif [ ${is_jats} -eq 1 ]; then
    pkg_fmt="https://datahub.deepgreen.org/FilesAndJATS"
  elif [ ${is_rsc} -eq 1 ]; then
    pkg_fmt="https://datahub.deepgreen.org/FilesAndRSC"
  else
    echo "error: no valid .xml (JATS or RSC) in zip archive found: stop."
    exit -2
  fi
else
  echo "error: no valid (or too many?!) .xml (JATS xor RSC) in zip archive found: stop."
  exit -3
fi

echo "`basename $0`: packaging format in zip archive found:"
echo "`basename $0`: ${pkg_fmt}"

${curl} -i -k -s -XPOST "${host_url}/api/v1/notification?api_key=${api_key}" -F "content=@${zip_file};type=application/zip" -F "metadata=@-;type=application/json" <<EOF
{
    "content" : {
        "packaging_format" : "${pkg_fmt}"
    }
}
EOF

echo

POST /validate?api_key=<api_key>
Content-Type: application/json

[Incoming Notification JSON]

HTTP 1.1  400 Bad Request
Content-Type: application/json

{
  "error" : "<verständliche(!) Fehlermeldung (auf englisch)>"
}

POST /notification?api_key=<api_key>
Content-Type: multipart/form-data; boundary=FulltextBoundary

--FulltextBoundary

Content-Disposition: form-data; name="metadata"
Content-Type: application/json

[Incoming Notification JSON]

--FulltextBoundary

Content-Disposition: form-data; name="content"
Content-Type: application/zip

[Package]

--FulltextBoundary--

POST /notification?api_key=<api_key>
Content-Type: multipart/form-data; boundary=FulltextBoundary

--FulltextBoundary

Content-Disposition: form-data; name="metadata"
Content-Type: application/json

{
    "content" : {
        "packaging_format" : "https://datahub.deepgreen.org/FilesAndJATS"
    }
}

--FulltextBoundary

Content-Disposition: form-data; name="content"
Content-Type: application/zip

[Package]

--FulltextBoundary--

HTTP 1.1  202 Accepted
Content-Type: application/json
Location: <URL des api-Endpunkts der akzeptierten Lieferung>

{
  "status" : "accepted",
  "id" : "<eindeutige ID dieser neuen Notifikation>",
  "location" : "<URL des api-Endpunkts dieser Notifikation>"
}

HTTP 1.1  400 Bad Request
Content-Type: application/json

{
  "error" : "<verständliche(!) Fehlermeldung (auf englisch)>"
}

GET <http-Adresse/...>?since=<YYYY-MM-DD>
#
# Angabe erforderlich; bestimmt, von wann ab die Notifikationen gelistet werden
#

GET <http-Adresse/...>?pageSize=<number>
#
# Angabe optional, voreingestellt auf 25, maximal 100; bestimmt, wieviele Datensätze auf einmal ausgegeben werden
#

GET <http-Adresse/...>?page=<number>
#
# Angabe optional, voreingestellt auf 1; bestimmt, welche Seite der Resultate ausgegeben wird
#

GET <http-Adresse/...>?api_key=<api_key>
#
# Angabe optional; mit der Angabe wird die Anfrage authentifiziert (z.B. für den Bezug von Volltexten)
#

{
  "analysis_date": "2016-08-09T14:22:11Z",
  "content": {
    "packaging_format": "string"
  },
  "created_date": "2016-08-09T14:22:11Z",
  "embargo": {
    "duration": 0
  },
  "id": "string",
  "issn_data": "string",
  "links": [
    {
      "format": "string",
      "packaging": "string",
      "type": "string",
      "url": "string"
    }
  ],
  "metadata": {
    "author": [
      {
        "affiliation": "string",
        "firstname": "string",
        "identifier": [
          {
            "id": "string",
            "type": "string"
          }
        ],
        "lastname": "string",
        "name": "string"
      }
    ],
    "date_accepted": "2016-08-09T14:22:11Z",
    "date_submitted": "2016-08-09T14:22:11Z",
    "fpage", "string",
    "identifier": [
      {
        "id": "string",
        "type": "string"
      }
    ],
    "issue", "string",
    "journal", "string",
    "license_ref": {
      "title": "string",
      "type": "string",
      "url": "string",
      "version": "string"
    },
    "lpage", "string",
    "project": [
      {
        "grant_number": "string",
        "identifier": [
          {
            "id": "string",
            "type": "string"
          }
        ],
        "name": "string"
      }
    ],
    "publication_date": "2016-08-09T14:22:11Z",
    "publisher": "string",
    "source": {
      "identifier": [
        {
          "id": "string",
          "type": "string"
        }
      ],
      "name": "string"
    },
    "subject": [
      "string"
    ],
    "title": "string",
    "volume": "string"
  }
}

GET /routed?since=<YYYY-MM-DD>[&<other params>]

HTTP 1.1  200 OK
Content-Type: application/json

{
  "since" : "<Datumsangabe der Form YYYY-MM-DDThh:mm:ssZ>",
  "page" : "<Seitenzahl dieser Trefferausgabe>",
  "pageSize" : "<Anzahl der Trefferausgabe pro Seite>",
  "timestamp" : "<Zeitstempel der Anfrage>",
  "total" : "<Anzahl der Treffer zu dieser Zeit>",
  "notifications" : [
     "<Liste der 'Outgoing Notification'-JSON-Objekte>"
  ]
}

HTTP 1.1  400 Bad Request
Content-Type: application/json

{
  "error" : "<verständliche(!) Fehlermeldung (auf englisch)>"
}

GET /routed/<repo_id>?since=<YYYY-MM-DD>[&<other params>]

HTTP 1.1  200 OK
Content-Type: application/json

{
  "since" : "<Datumsangabe der Form YYYY-MM-DDThh:mm:ssZ>",
  "page" : "<Seitenzahl dieser Trefferausgabe>",
  "pageSize" : "<Anzahl der Trefferausgabe pro Seite>",
  "timestamp" : "<Zeitstempel der Anfrage>",
  "total" : "<Anzahl der Treffer zu dieser Zeit>",
  "notifications" : [
     "<Liste der 'Outgoing Notification'-JSON-Objekte>"
  ]
}

HTTP 1.1  400 Bad Request
Content-Type: application/json

{
  "error" : "<verständliche(!) Fehlermeldung (auf englisch)>"
}

GET /notification/<notification_id>

HTTP 1.1  200 OK
Content-Type: application/json

[Outgoing Notification JSON]

"links" : [
   {
     "type" : "package",
     "format" : "application/zip",
     "url" : "https://www.oa-deepgreen.de/api/v1/notification/123456789/content",
     "packaging" : "https://datahub.deepgreen.org/FilesAndJATS"
   },
   {
     "type" : "package",
     "format" : "application/zip",
     "url" : "https://www.oa-deepgreen.de/api/v1/notification/123456789/content/SimpleZip",
     "packaging" : "http://purl.org/net/sword/package/SimpleZip"
   }
 ]

GET <links url>?api_key=<api_key>

HTTP 1.1  200 OK
Content-Type: application/zip

[(binäres) Paket]

GET /config?api_key=<api_key>

HTTP 1.1  200 OK
Content-Type: application/json

[matching Kriterien JSON]

POST /config?api_key=<api_key>
Content-Type: application/json; charset=utf-8

[Overwriting new match config settings JSON]

HTTP 1.1  200 OK
Content-Length: 0

{
  "name_variants": [
    "Academia Fridericiana Erlangensis",
    "Academia Friderico Alexandrina Erlangen-Nürnberg",
    "Academia Friderico-Alexandrina",
    "Academia Regia Bavarica Friderico-Alexandrina",
    "Academia Regia Friderico-Alexandrina",
    "Bayerische Friedrich-Alexanders-Universität",
    "F.A.U. Erlangen-Nürnberg",
    "University of Erlangen"
  ],
  "grants": [
    "2491691", "2673762", "6273863"
  ],
  "domains": [
    "fau.de", "uk-erlangen.de", "uni-erlangen.de"
  ],
  "keywords": [
    "research", "bavarian", "erlangen"
  ]
}

Feldbezeichner	Beschreibung
analysis_date	Zeitpunkt der Zustellanalyse
content.packaging_format	Format der zugehörigen Binärpakets (meist .zip)
created_date	Zeitpunkt, wann die Notifikation angelegt wurde
embargo.duration	Sperrzeit (Embargo; angegeben in Monaten)
id	Persistenter System-ID für diese Notifikation
links.format	MIME-Typ der Quelle
links.packaging	Paketformat der Quelle
links.type	Schlagwort für den Typ der Quelle (z.B. package)
links.url	URL für die Quelle (verlags- oder systemseitig)
metadata.author.affiliation	Affiliationsangabe, ermittelt aus den Metadaten
metadata.author.firstname	Vorname eines Autors/Urhebers
metadata.author.lastname	Nachname eines Autors/Urhebers
metadata.author.name	Zusammengesetzter Name eines Autors/Urhebers
metadata.date_accepted	Datum, wann die Publikation akzeptiert wurde
metadata.date_submitted	Datum, wann die Publikation eingereicht wurde
metadata.fpage	Erste Seitenzahl der Publikation
metadata.identifier.id	ID für die Publikation (z.B. DOI)
metadata.identifier.type	ID-Typ (z.B. „doi“; allerdings kein Vokabular)
metadata.issue	Heftzählung (Journalheft)
metadata.journal	Name des Journals der Publikation (Journaltitel)
metadata.license_ref.title	Name einer Lizenz (Freifeldtext)
metadata.license_ref.type	Lizenz-Typ (Freifeldtext)
metadata.license_ref.url	URL, die zu weiteren Lizenzinformationen führt
metadata.license_ref.version	Version einer Lizenz
metadata.lpage	Letzte Seitenzahl der Publikation
metadata.project.grant_number	Förderkürzel, sofern in den Metadaten angeführt
metadata.project.identifier.id	ID einer Förderung (z.B. Ringold)
metadata.project.identifier.type	ID-Typ in Bezug auf die Förder-ID
metadata.project.name	Name eines Förders / einer Förderinstitution
metadata.publication_date	Publikationsdatum
metadata.publisher	Verlagsname bzw. Verlag
metadata.source.identifier.id	ID der Veröffentlichungsquelle (z.B. ISSN)
metadata.source.identifier.type	ID-Typ der Veröffentlichungsquelle
metadata.source.name	Name der Veröffentlichungsquelle (Journaltitel)
metadata.subject	Schlagwort
metadata.title	Titel der Veröffentlichung
metadata.volume	Bandzählung (Journalband)

NISO JATS (tag)	METSMODS (xpath)	Belegung in METSMODS (Beispiel)
n/a	//mods/typeOfResource	text
n/a	//mods/genre	journal article
<article>	//mods/language/languageTerm	EN
<article-title>	//mods/titleInfo/title	A Short Discussion on…

NISO JATS (tag)	METSMODS (xpath)	Belegung in METSMODS (Beispiel)
<journal-title>	titleInfo/title	Acta numerica
<journal-id>	identifier[@type=“publisher-id“]	Act. Num.
<issn>	identifier[@type=“eIssn“]	1234-234X
<issn>	identifier[@type=“pIssn“]	5432-9634
<volume>	part/detail[@type=“volume“]/number	7
<issue>	part/detail[@type=“issue“]/number	10
<fpage>	part/extent[@unit=“pages“]/start	521
<lpage>	part/extent[@unit=“pages“]/end	534

NISO JATS (tag)	METSMODS (xpath)	Belegung in METSMODS (Beispiel)
<surname>	namePart[@type=“family“]	Hoppenstadt
<given-names>	namePart[@type=“given“]	Dickie M.
<contrib>	role/roleTerm[@type=“text“]	author
<contrib-id>	nameIdentifier[@type=“orcid“]	1111-1010-1111-0101
<aff>	affiliation	Zuse Institut Berlin

NISO JATS (tag)	METSMODS (xpath)	Belegung in METSMODS (Beispiel)
<abstract>	///mods/abstract	In this paper we will …
<kwd>	//mods/subject/topic	viscoelasticity

Hilfe

FAQ

Dokumentation

Forum

Screencasts

FAQ

Betriebs- und Kostenmodell

Erwartungen und Aufwand

Rechtliches und Lizenzen

Anmeldung

DeepGreen-Kontozugänge

Affiliationsdatei

Technisches

Dokumentation

Handreichungen

Technische Dokumentation

Verfügbare Schnittstellen für Verlage

SFTP

Verfügbare Schnittstellen für Repositorien

Web-API (nativ)

Artikeldaten an DeepGreen liefern¶

Rückgabewerte bei `validation` (hier am Beispiel: Nur Metadaten abliefern)¶

Rückgabewerte bei `notification` (am Beispiel: Metadaten samt Volltext(e) abliefern)¶

Artikeldaten von DeepGreen erhalten¶

Volles JSON-Schema für `Outgoing Notification` (alphabetisch sortiert nach den Schlüsseln)¶

Liste aller erfolgreich zugestellten Artikel¶

Liste der einer Einrichtung zugestellten Artikel¶

Abfrage eines bestimmten Artikels¶

Abruf der Binärdaten einer Notifikation¶

Abfrage und Update der `match-config`-Setzungen bei Repositorien¶

Update der `matching`-Kriterien eines Repositorienkontos¶

Konkordanz NISO JATS zu METSMODS

Das Repositorien-Konto

Die Affiliationsdatei

Beispiel einer match-config-Datei

Forum

Screencasts

//mods/originInfo
NISO JATS (tag)	METSMODS (xpath)	Belegung in METSMODS (Beispiel)
<publisher-name>	publisher	MDPI
<publisher-loc>	place/placeTerm[@type=“text“]	Basel
<pub-date>	dateIssued[@encoding=“iso8601″]	2015-02-23
<date>	dateOther[@type=“accepted“]	2015-02-20
<date>	dateOther[@type=“received“]	2015-12-24