Difference between revisions of "Altmetric badges"

From EPrints Documentation
Jump to: navigation, search
(Created page with "The Altmetric plugin for EPrints is available from the [https://bazaar.eprints.org/555/ Bazaar] or [https://github.com/eprintsug/altmetric/ GitHub]. The Altmetric badges can...")
 
 
Line 1: Line 1:
The Altmetric plugin for EPrints is available from the [https://bazaar.eprints.org/555/ Bazaar] or [https://github.com/eprintsug/altmetric/ GitHub].
+
The Altmetric plugin for EPrints is available from the [https://bazaar.eprints.org/1300/ Bazaar] or [https://github.com/eprintsug/altmetric/ GitHub] (see the '3_4' branch for the 'ingredient' version).
 
 
The Altmetric badges can also be added to pages by following the instructions here: [https://badge-docs.altmetric.com/index.html]
 
  
 
== Changes (November 2025) - API key now mandatory ==
 
== Changes (November 2025) - API key now mandatory ==
The Altmetric plugin uses the Altmetric API to get data. If you are using this to display Altmetric badges, please check to see if you have an API key defined.
+
Before v2.0.0 the Altmetric plugin used the Altmetric API to get data. In v2.0.0+ this has been updated to use the API if an API key is defined, and fall back to
This should be in <code>EPRINTS_ROOT/archives/ARCHIVEID/cfg/cfg.d/z_altmetric.pl</code>, although may have been defined in another config file.
+
the Altmetric 'embed' script to display the badges.
 
 
From: https://github.com/eprintsug/altmetric/blob/main/cfg/cfg.d/z_altmetric.pl#L20-L21
 
 
 
<source lang=perl>
 
# Optional API key - see http://api.altmetric.com/index.html#keys
 
# $c->{altmetric}->{api_key} = "";
 
</source>
 
  
An upcoming update to the plugin will start requiring this to be set before rendering a badge on a page.
+
Please see the README at https://github.com/eprintsug/altmetric/ for full details.
  
The future of this integration may be a deprecation of the 'API' route, and support a configurable embedded badge instead.
+
You can also embed the badges without this plugin - see instructions here: [https://badge-docs.altmetric.com/index.html], although the plugin assists in finding relevant identifiers within a record to display.

Latest revision as of 15:03, 6 November 2025

The Altmetric plugin for EPrints is available from the Bazaar or GitHub (see the '3_4' branch for the 'ingredient' version).

Changes (November 2025) - API key now mandatory

Before v2.0.0 the Altmetric plugin used the Altmetric API to get data. In v2.0.0+ this has been updated to use the API if an API key is defined, and fall back to the Altmetric 'embed' script to display the badges.

Please see the README at https://github.com/eprintsug/altmetric/ for full details.

You can also embed the badges without this plugin - see instructions here: [1], although the plugin assists in finding relevant identifiers within a record to display.