Über die REST-API
Coscine verfügt über eine Programmierschnittstelle, mit der sich Arbeitsabläufe automatisieren lassen.
REST API
Mit Coscine kann über eine REST Schnittstelle (REpresentational State Transfer) interagiert werden. Dazu benötigen Sie zunächst ein Zugriffstoken, welches Sie in Ihrem Benutzerprofil anlegen können (siehe Zugriffstoken erstellen). 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
| Endpoint | Description | Link |
|---|---|---|
| Admin | This API provides endpoints for coscine admin utilities. | Admin |
| BlobApi | The BlobApi handles the interaction with binary large objects in the Coscine environment. | BlobApi |
| Metadata | This api provides methods for interacting with metadata. | Metadata |
| Notices | This project provides the Rest Api for dealing with markdown files. | Notices |
| Organization | This api provides methods for interacting with organizations. | Organization |
| Pid | This api handles the request for the public pid page. | Pid |
| Project | This api provides methods to access, create and update project information. | Project |
| Resources | This api provides methods for interacting with resources. | Resources |
| Search | API for the search. | Search |
| STS | This projects provides the funtionality of a secure token service for the Coscine platform. | Token |
| Token | This Api handles the Token management. | Token |
| TreeApi | The TreeApi handles the retrieving or storing metadata to a certain path. | TreeApi |
| User | This api provides methods to access and update user information. | Project |
Unterstützung in Programmiersprachen
Die Coscine REST API können Sie mit einer Vielzahl an Programmiersprachen nutzen. Eine Client-Bibliothek in der Programmiersprache Python wird derzeit aktiv von der Coscine Nutzerbase gepflegt:
Kontaktieren Sie uns gerne, wenn Sie ein Script oder eine Bibliothek zur Interaktion mit Coscine geschrieben haben, und dies auch anderen Nutzern zugänglich machen möchten. Coscine und dessen Nutzer profitieren als Open-Source Projekt direkt von Beiträgen der Community. Gemeinsam lässt sich mehr erreichen - zögern Sie daher nicht Ihre Arbeit auch nach außen zu tragen, sofern Ihnen dadurch kein Nachteil entsteht.