(Die Seite wurde neu angelegt: „Ein '''Webservice''' ist eine Programmfunktion zur Bereitstellung von Schnittstellen über das HTTP-Protokoll. Um die Programmfunktion nutzen zu können…“) Markierung: 2017-Quelltext-Bearbeitung |
Markierung: 2017-Quelltext-Bearbeitung |
||
| (9 dazwischenliegende Versionen von 3 Benutzern werden nicht angezeigt) | |||
| Zeile 1: | Zeile 1: | ||
Ein '''Webservice''' ist eine [[Programmfunktion]] zur Bereitstellung von Schnittstellen über das HTTP-Protokoll. | Ein '''Webservice''' ist eine [[Programmfunktion]] zur Bereitstellung von Schnittstellen über das HTTP-Protokoll. | ||
== Voraussetzungen == | |||
Um die Programmfunktion nutzen zu können | Um die Programmfunktion nutzen zu können | ||
* muss der [[Intern:ALEX-Config-File-AddOns#httpServicePlugins|Webservice-Daemon]] konfiguriert sein. | * muss der [[Intern:ALEX-Config-File-AddOns#httpServicePlugins|Webservice-Daemon]] konfiguriert sein. | ||
* muss ein gültiger [[ALEX-Ports#. | * muss ein gültiger [[ALEX-Ports#httpServer.port_.3D_WebApi-Port|WebApi-Port]] konfiguriert sein. | ||
* kann ein Zertifikat zur [[Verschlüsselung]] verwendet werden. | * kann ein Zertifikat zur [[Verschlüsselung]] verwendet werden. | ||
* kann ein [[Webservice_Authorization|Sicherer Link-Aufruf]] konfiguriert werden. | * kann ein [[Webservice_Authorization|Sicherer Link-Aufruf]] konfiguriert werden. | ||
Das Webservice stellt dann Zugriffspfade an der konfigurierten [[ALEX-Ports#Netzwerkadresse_.2B_Port|Webservice-Adresse]] zur Verfügung. | Das Webservice stellt dann Zugriffspfade an der konfigurierten [[ALEX-Ports#Netzwerkadresse_.2B_Port|Webservice-Adresse]] zur Verfügung. | ||
Der Bediener des Webservice muss mit dem '''HTTP-Protokoll''' und seinen '''Möglichkeiten zur Argumentübertragung'''<ref name="refHTTP1">https://www.w3schools.com/tags/ref_httpmethods.asp</ref><ref name="refHTTP2">https://de.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Argument%C3%BCbertragung</ref> vertraut sein. | |||
Der Bediener muss das Format der Anfrage und Ausgabe kennen. | |||
== http-client-example == | |||
[https://github.com/bitfactory-software/http-client-example Sourcecode] | |||
Dieses Beispielprogramm in HTML und JavaScript dient zur Veranschaulichung der Bedienung eines {{Alex}}-Webservice. | |||
Mit diesem Beispielprogramm kann | |||
* ein HTTP-GET Request an ein Webservice gesendet werden (Body-Eingabefeld bleibt leer) | |||
* ein HTTP-POST Request an ein Webservice gesendet werden (Body-Eingabefeld ist gefüllt) | |||
* ein API-Key gesendet werden | |||
Im Response-Ausgabefeld wird das Ergebnis des Aufrufs angezeigt. | |||
Mit diesem Beispielprogramm können alle {{Alex}}-Webservices bedient werden. | |||
{{AlexBild|http-client-example|[[Datei:Webservice 1677590974711.png|300px]]}} | |||
== Fußnoten == | |||
[[Kategorie:Webservice]] | |||
[[Kategorie:Schnittstellen]] | |||
Aktuelle Version vom 31. Oktober 2024, 11:05 Uhr
Ein Webservice ist eine Programmfunktion zur Bereitstellung von Schnittstellen über das HTTP-Protokoll.
Voraussetzungen
Um die Programmfunktion nutzen zu können
- muss der Webservice-Daemon konfiguriert sein.
- muss ein gültiger WebApi-Port konfiguriert sein.
- kann ein Zertifikat zur Verschlüsselung verwendet werden.
- kann ein Sicherer Link-Aufruf konfiguriert werden.
Das Webservice stellt dann Zugriffspfade an der konfigurierten Webservice-Adresse zur Verfügung.
Der Bediener des Webservice muss mit dem HTTP-Protokoll und seinen Möglichkeiten zur Argumentübertragung[1][2] vertraut sein.
Der Bediener muss das Format der Anfrage und Ausgabe kennen.
http-client-example
Dieses Beispielprogramm in HTML und JavaScript dient zur Veranschaulichung der Bedienung eines Alex®-Webservice.
Mit diesem Beispielprogramm kann
- ein HTTP-GET Request an ein Webservice gesendet werden (Body-Eingabefeld bleibt leer)
- ein HTTP-POST Request an ein Webservice gesendet werden (Body-Eingabefeld ist gefüllt)
- ein API-Key gesendet werden
Im Response-Ausgabefeld wird das Ergebnis des Aufrufs angezeigt.
Mit diesem Beispielprogramm können alle Alex®-Webservices bedient werden.
| http-client-example |
|
