Sie befinden sich im Service: Coscine

API

API

Kurzinformation

Coscine verfügt über eine Programmierschnittstelle, mit der sich Arbeitsabläufe automatisieren lassen. Im Folgenden erfahren Sie mehr zur Nutzung der Coscine API.


Detailinformation

Mit Coscine kann über eine REST Schnittstelle (REpresentational State Transfer) interagiert werden. Dazu benötigen Sie zunächst ein Zugriffstoken. Wie Sie in Ihrem Benutzerprofil ein persönliches Zugriffstoken anlegen können, wird Ihnen im Text Zugriffstoken erstellen beschrieben. Sobald Sie über ein Zugriffstoken verfügen, können Sie die API nutzen.

Um sich mit den einzelnen Funktionen und deren Benutzung vertraut zu machen, sollten Sie einen Blick in die jeweilige API Dokumentationsseite werfen. Dort können Sie die Funktionen auch mit eigenen Parametern testen.

API Struktur
EndpointDescriptionLink
NotificationsThe NotificationApi handles the sync and async sending of notification.https://coscine.rwth-aachen.de/coscine/api/Coscine.Api.Notification/swagger/index.html
Resources

This api provides methods for interacting with resources.

https://coscine.rwth-aachen.de/coscine/api/Coscine.Api.Resources/swagger/index.html
Project

This api provides methods to access, create and update project information.

https://coscine.rwth-aachen.de/coscine/api/Coscine.Api.Project/swagger/index.html
UserThis api provides methods to access and update user information.https://coscine.rwth-aachen.de/coscine/api/Coscine.Api.User/swagger/index.html
TreeApiThe TreeApi handles the retrieving or storing metadata to a certain path.https://coscine.rwth-aachen.de/coscine/api/Coscine.Api.Tree/swagger/index.html
OrganizationThis api provides methods for interacting with organizations.https://coscine.rwth-aachen.de/coscine/api/Coscine.Api.Organization/swagger/index.html
BlobApiThe BlobApi handles the interaction with binary large objects in the Coscine environment.https://coscine.rwth-aachen.de/coscine/api/Coscine.Api.Blob/swagger/index.html
MetadataThis api provides methods for interacting with metadata.https://coscine.rwth-aachen.de/coscine/api/Coscine.Api.Metadata/swagger/index.html

Unterstützung in Programmiersprachen

Die API können Sie mit einer Vielzahl an Programmiersprachen nutzen. Ein Beispiel in der Programmiersprache Python haben wir bereits für Sie implementiert:

https://git.rwth-aachen.de/coscine/docs/public/wiki/-/blob/master/tutorials/api-interaction/python/Step-by-step%20API%20connection%20tutorial.md

Anhand des Beispielprogramms lernen Sie die Coscine API Schritt für Schritt in der Programmiersprache Ihrer Wahl zu nutzen. Sie können das Beispiel als erfahrener Python Nutzer auch überspringen und direkt die daraus entstandene Bibliothek in Ihr eigenes Programm einbinden. Dennoch macht es Sinn sich vorher die Schritt-für-Schritt Anleitung einmal anzuschauen. Das Repository für den Pythonconnector ist über folgenden Link abrufbar:

https://git.rwth-aachen.de/coscine/docs/public/wiki/-/tree/master/tutorials/api-interaction/python

zuletzt geändert am 11.02.2021

Wie hat Ihnen dieser Inhalt geholfen?