EPrints Technical Mailing List Archive

See the EPrints wiki for instructions on how to join this mailing list and related information.

Message: #10279

< Previous (by date) | Next (by date) > | < Previous (in thread) | Next (in thread) > | Messages - Most Recent First | Threads - Most Recent First

RE: [EP-tech] Altmetric plugin - API key soon to be made mandatory

CAUTION: This e-mail originated outside the University of Southampton.

Hi All,
I’ve made a new version of the Altmetric plugin.

 

It’s available as:

- an ingredient (currently https://github.com/eprintsug/altmetric/tree/v2, although this branch will be merged into the 3_4 branch)

- an EPM (https://github.com/eprintsug/altmetric/blob/main/altmetric.epm).

 

If any of you are in a position to test this, you will need to install the new version, and then refresh abstracts.

If you don’t have an Altmetric API key, the badges will now be displayed via the Altmetric ‘embed’ _javascript_.

 

There is info in the z_altmetric.pl file about options for both the API-based and embed badges.

 

  • If you have an API key, you will be able to customise the phrases/metrics displayed.

The text e.g. ‘3 facebook pages’ now use EPrints phrases, so the plugin now supports internationalisation/multi-lingual repositories better.

Thie requires an API key.

 

  • If you have a custom altmetric.css or 99_altmetric.js files, these may need to be removed/re-synced with the new versions.

 

If it seems to work OK for anyone who tests it, I will add the EPM to the Bazaar, and merge v2 into the 3_4 branch.

 

Any comments/feedback welcome.

Cheers,

John

 

PS The API key will become mandatory on the 10th November – if you haven’t updated by then, your Altmetrics badges may disappear.

 

From: eprints-tech-request@ecs.soton.ac.uk <eprints-tech-request@ecs.soton.ac.uk> On Behalf Of John Salter
Sent: 22 October 2025 13:37
To: 'eprints-tech@ecs.soton.ac.uk' <eprints-tech@ecs.soton.ac.uk>
Subject: [EP-tech] Altmetric plugin - API key soon to be made mandatory

 

CAUTION: External Message. Use caution opening links and attachments.

CAUTION: This e-mail originated outside the University of Southampton.

CAUTION: This e-mail originated outside the University of Southampton.

Hi,
I’ve been contacted by the Altmetric team, as there will soon (10th November) be a change to their API, to require an API key.

 

If you use the Altmetric plugin, and haven’t already configured an API key, you will need to either:

  • register for an API key and add it to your configuration
  • change to using the embedded version of the badges.

 

I’ve put some details here: https://wiki.eprints.org/w/Altmetric_badges

 

Altmetric ran a test of this change this morning, and I checked a few repositories. If there isn’t an API key configured, an error message is displayed, although this doesn’t indicate that it’s an API key issue.

 

A new version of the plugin will be released (which also has other changes in it to improve accessibility and internationalisation).

This will use the existing API-based display if a key has been configured, and fall back to the embedded version if not.

 

This will be advertised here when released.

 

Cheers,

John

 

John Salter

https://orcid.org/0000-0002-8611-8266

 

White Rose Libraries Technical Officer
Library and Research Management team, IT
University of Leeds