<WRAP group>
<WRAP box>
<WRAP left>
{{:beecollect_cloud_250.png?nolink|}}
</WRAP>
<WRAP left>
====== BeeCollect Cloud API ======
</WRAP>
</WRAP>
</WRAP>


<WRAP group>
<WRAP column right>

[[:start|{{ ::icon-home-64.png?nolink|Startseite}}]]
</WRAP>
<WRAP twothirds column>

Die BeeCollect Cloud API ermöglicht das sichere Hoch- und Herunterladen von Daten und Medien in die BeeCollect Cloud über ein modernes Authentifizierungs- und Freigabeverfahren. Daten und Medien können dabei nur von entsprechend berechtigten Akteuren eingesehen oder verändert werden.

==== URL und Zugang =====

Die API wird dabei über folgende URL erreicht:

[[https://beecollect.cloud/api/]]

Der allgemeine Zugang ist dabei über eine HTTP Basic Authentication abgesichert, die Zugangsdaten erfragen Sie bei Bedarf bitte unter der E-Mail-Adresse support@solvatec.com.

==== Swagger YAML =====

Für die unkomplizierte Implementierung der BeeCollect Cloud API in andere Systeme stellen wir die vollständige API-Deklaration als [[https://beecollect.cloud/swagger/index.html|Swagger YAML]] bereit. Das YAML enthält sowohl sämtliche Endpunkte der API mit ihrer jeweiligen Parametrierung als auch alle für den Datenaustausch benötigten Objektdefinitionen. Damit ist die unkomplizierte Serialisierung / Deserialisierung aller gelieferten und zu liefernden JSON-Daten möglich.

==== Endpunkte / Funktionen =====

Die folgenden Endpunkte sind in der BeeCollect Cloud API Version 1.0 aktuell implementiert:

== System-Status ==
  * [[cloud-api:endpoints:v1:ping|Ping]]

== Authentifizierung ==
  * [[cloud-api:endpoints:v1:getaccesstoken|GetAccessToken]]
  * [[cloud-api:endpoints:v1:getsharekeys|GetShareKeys]]
  * [[cloud-api:endpoints:v1:getorganisationname|GetOrganisationName]]
  * [[cloud-api:endpoints:v1:getorganisationinfo|GetOrganisationInfo]]
  * [[cloud-api:endpoints:v1:requestsharekey|RequestShareKey]]

== Daten senden / empfangen ==
  * [[cloud-api:endpoints:v1:getdataitemcount|GetDataItemCount]]
  * [[cloud-api:endpoints:v1:getdataitemkeys|GetDataItemKeys]]
  * [[cloud-api:endpoints:v1:selectdata|SelectData]]
  * [[cloud-api:endpoints:v1:updatedata|UpdateData]]
  * [[cloud-api:endpoints:v1:deletedata|DeleteData]]
  * [[cloud-api:endpoints:v1:asignsharekey|AssignShareKey]]
  * [[cloud-api:endpoints:v1:unassignsharekey|UnassignShareKey]]

== Medien senden / empfangen ==
  * [[cloud-api:endpoints:v1:downloadmedium|DownloadMedium]]
  * [[cloud-api:endpoints:v1:uploadmedium|UploadMedium]]

== Systemverwaltung (nicht öffentlich) ==
  * [[cloud-api:endpoints:v1:getdatafieldcatalog|GetDataFieldCatalog]]
  * [[cloud-api:endpoints:v1:uploaddatafieldcatalog|UploadDataFieldCatalog]]
  * [[cloud-api:endpoints:v1:getoaipmhsettings|GetOaiPmhSettings]]
  * [[cloud-api:endpoints:v1:setoaipmhsettings|SetOaiPmhSettings]]

</WRAP>
</WRAP>