GRSciColl API - get started

What can the GRSciColl API do

The GRSciColl API can allow you to edit or retrieve programmatically GRSciColl records. This API is part of the GBIF registry API and is fully documented. All the functions available in the GRSciColl website and editing interface are also available in the API, including adding, editing and deleting records as well as making update suggestions. In addition to that, the permission system is the same in the web interface and the API.

The API also offers the possibility to upload and update records in bulk.

How and when to use the GRSciColl API

In order to use the GRSciColl API, you will need to use a client in the programming language of your choice. For example, you can use the requests library in Python or the httr2 library in R. This will allow you to use any of the API functions available.

Если вы хотите получить базовое представление об API GBIF в целом, вы можете посмотреть запись вебинара или прочитать запись в блоге.

Если вы хотите редактировать записи GRSciColl программным способом с помощью API, вам необходимо найти и использовать ключи тех записей, которые вы хотите отредактировать. Например, если вы хотите отредактировать запись о New York Botanical Garden, вам нужно будет использовать UUID из его URL-адреса: ab83e5ab-f4f7-4c9b-a1d5-eb779dfb9377. Это позволит вам привязать информацию к правильной записи (см. также документацию по обновлению данных об учреждении).

If you maintain your own database or registry of collections and would like to push updates to GRSciColl, you can use the GRSciColl API. You just need to store the keys of the corresponding GRSciColl collection and institution entries on your side to ensure that the correct entries get updated.

In this module, we won’t go over the details of how the API can be used to update GRSciColl records. If you are thinking of making updates programmatically and you are unsure of how to proceed, please contact scientific-collections@gbif.org. We can help you write a script adapted to your needs.

Проверка знаний

Quiz yourself on the concepts covered in this module.

Верно или Неверно?

  1. The GRSciColl API allows to create programmatically new entries in GRSciColl.

    • Верно

    • Неверно

    • Верно

    • Неверно

  2. The permission system is the same for the GRSciColl API and the GRSciColl editing interface.

    • Верно

    • Неверно

    • Верно

    • Неверно

  3. You can only use the GRSciColl API in the programming language Python.

    • Верно

    • Неверно

    • Верно

    • Неверно

  4. The UUID of this GRSciColl institution associated with the code NHMUK is d2a27206-87ab-47ea-b5fc-d2e57054b688

    • Верно

    • Неверно

    • Верно

    • Неверно