API – Nucleus Help https://nucleus-help.bmt.bafta.org Help Articles and FAQs for the BAFTA Nucleus Awards and Grants Management System Thu, 27 Feb 2025 12:52:14 +0000 en-GB hourly 1 https://wordpress.org/?v=6.9.1 https://nucleus-help.bmt.bafta.org/wp-content/uploads/2021/07/bafta-mask_favicon_website21-1.png API – Nucleus Help https://nucleus-help.bmt.bafta.org 32 32 How to Set the API in Nucleus https://nucleus-help.bmt.bafta.org/help-articles/how-to-set-the-api-in-nucleus/ Tue, 22 Aug 2023 17:05:14 +0000 https://nucleus-help.bmt.bafta.org/?post_type=lsvr_kba&p=1413 Nucleus provides an API which allows external systems to programmatically access details of awards, categories, entries and videos. All of the data that is used to build the structure of the Viewing Interface can be accessed via the API and used within an external system, note that additional development by BMT or the external systems developers is likely to be required. This guide details technical aspects API in Nucleus.

Nucleus API Checklist

This list contains all the steps and configurations that need to be active in order for the data to be exported.

  1. The Award needs to be Active. More information on how to change the Status of Awards can be found here.
  2. At least one “Title for API name” needs to be set from the Question List. Full information can be found in this guide. Note that the value for each API name field must be unique.
  3. The “Enable Nucleus API” field has to be set to: Yes, True or 1.
    To access this, go to Control Centre, click on Configuration Values under System Administration. On the first column look for “Enable Nucleus API”.
  4. The API keys need to be created.
    To action this, go to Control Centre, click API Keys under System Administration. For full instructions read this guide.
  5. The Entry needs to be approved.
  6. A Viewer account for the API needs to be created. To do this a Viewer is set up as normal and is used by the API to access content. Therefore an admin user can log in as the viewer to see if the content is visible. The Viewer must have:
  • The relevant Award permission
  • The relevant Category/ies access
]]>