Skip to main content
ExLibris
Ex Libris Knowledge Center

Changes to PubMed Metadata Augmentation

If you are using PubMed augmentation, note that as of December 1st, 2018, there will be a change to the way PubMed metadata augmentation is performed and the use of a customer-specific API key will be required. To obtain the API key, you must create an account on PubMed. For information on how to do this, see https://ncbiinsights.ncbi.nlm.nih.gov/2017/11/02/new-api-keys-for-the-e-utilities/. Note that one key should be generated per instance.
Currently, SFX uses the following syntax to fetch metadata:
https://www.ncbi.nlm.nih.gov/entrez/eutils/efetch.fcgi?db=pubmed&retmode=xml&id=
When the API key is added, the following will be appended to the URL: &api_key=
After you generate an API key using PubMed's instructions, include this key in a new field in /exlibris/sfx_ver/sfx4_1//config/source/OpenURL_0_1/pmid.config_ as follows:
#
# PubMed configuration
#
Section "source"
        id               "PUBMED"
EndSection
Section "parsePrivateID"
        module          "Parsers::SourceParser::OpenURL_0_1::pmid"
EndSection
Section "fetchRecord"
        module          "NetWrap::HTTP"
        host            https://www.ncbi.nlm.nih.gov
        timeout         "3"
        api_key         ""
EndSection
Section "parseRecord"
         module         "Parsers::SourceParser::OpenURL_0_1::pmid"
EndSection
If the parameter does not exist or is blank, the api_key element will not be appended to the API fetch request.
Note that if you do not include a PubMed API key, SFX will continue to augment using the previous syntax, but we cannot guarantee how long PubMed will be backward compatible in this respect.
  • Was this article helpful?