GOV/Webservice - Versionsgeschichte

Jzedlitz am 5. Mai 2024 um 05:51 Uhr

2024-05-05T05:51:20Z

← Nächstältere Version		Version vom 5. Mai 2024, 07:51 Uhr
Zeile 16:		Zeile 16:
	== REST API ==		== REST API ==
	Mit einem einfachen Web-Aufruf kann man per REST<ref>{{Wikipedia-Link\|Representational State Transfer}}</ref> in JSON<ref>{{Wikipedia-Link\|JSON}}</ref> dargestellte Informationen zu einer GOV-ID abfragen.		Mit einem einfachen Web-Aufruf kann man per REST<ref>{{Wikipedia-Link\|Representational State Transfer}}</ref> in JSON<ref>{{Wikipedia-Link\|JSON}}</ref> dargestellte Informationen zu einer GOV-ID abfragen.
	* ''information=position&<GOV-ID>'' liefert die geografische Position einen Ortes: http://gov.genealogy.net/api?information=position&id=SCHERGJO54EJ
	* ''information=name&<GOV-ID>'' liefert den Namen zu einer GOV-ID: http://gov.genealogy.net/api?information=name&id=SCHERGJO54EJ
	* Bei Orten mit Namen in mehreren Sprachen kann zusätzlich mit dem ''lang''-Parameter die gewünschte Sprache angegeben werden: http://gov.genealogy.net/api?information=name&id=KETORFJO70XW&lang=pol
	* ''information=data'' liefert die kompletten Informationen in JSON: http://gov.genealogy.net/api?information=data&id=SCHERGJO54EJ

	~~Formale Dokumentation aller Parameter nach dem '=' in ''information='' siehe~~ https://gov~~-dev~~.genealogy.net/swagger-ui/index.html.		Die Beschreibung der Schnittstelle (mit Möglichkeiten zum Ausprobieren) sind hier zu finden: https://gov.genealogy.net/swagger-ui/index.html.

	== SOAP API ==		== SOAP API ==

PLingnau: Straffung

2023-11-04T18:12:46Z

Straffung

← Nächstältere Version		Version vom 4. November 2023, 20:12 Uhr
Zeile 6:		Zeile 6:
	Über Webservices erhält man einen maschinellen Zugriff auf die Daten des GOV, der inhaltlich dem Zugriff über das Webfrontend entspricht. Mit Webservices kann beispielsweise ein geübter Programmierer die Informationen aus GOV in ein genealogisches Programm einbinden. Für das Programm [[webtrees]] ist beispielsweise ein entsprechendes [[Webtrees Handbuch/Anleitung für Webmaster/Erweiterungsmodule\|Erweiterungsmodul]] verfügbar ("[[Webtrees Handbuch/Anleitung für Webmaster/Erweiterungsmodule/vesta gov4webtrees\|vesta gov4webtrees]]").		Über Webservices erhält man einen maschinellen Zugriff auf die Daten des GOV, der inhaltlich dem Zugriff über das Webfrontend entspricht. Mit Webservices kann beispielsweise ein geübter Programmierer die Informationen aus GOV in ein genealogisches Programm einbinden. Für das Programm [[webtrees]] ist beispielsweise ein entsprechendes [[Webtrees Handbuch/Anleitung für Webmaster/Erweiterungsmodule\|Erweiterungsmodul]] verfügbar ("[[Webtrees Handbuch/Anleitung für Webmaster/Erweiterungsmodule/vesta gov4webtrees\|vesta gov4webtrees]]").

	~~Um die~~ GOV-Webservices ~~zu nutzen ist~~ keine Authentifizierung ~~nötig~~.		Die GOV-Webservices erfordern keine Authentifizierung.

	== Lizenz ==		== Lizenz ==
Zeile 16:		Zeile 16:
	== REST API ==		== REST API ==
	Mit einem einfachen Web-Aufruf kann man per REST<ref>{{Wikipedia-Link\|Representational State Transfer}}</ref> in JSON<ref>{{Wikipedia-Link\|JSON}}</ref> dargestellte Informationen zu einer GOV-ID abfragen.		Mit einem einfachen Web-Aufruf kann man per REST<ref>{{Wikipedia-Link\|Representational State Transfer}}</ref> in JSON<ref>{{Wikipedia-Link\|JSON}}</ref> dargestellte Informationen zu einer GOV-ID abfragen.
			* ''information=position&<GOV-ID>'' liefert die geografische Position einen Ortes: http://gov.genealogy.net/api?information=position&id=SCHERGJO54EJ
			* ''information=name&<GOV-ID>'' liefert den Namen zu einer GOV-ID: http://gov.genealogy.net/api?information=name&id=SCHERGJO54EJ
			* Bei Orten mit Namen in mehreren Sprachen kann zusätzlich mit dem ''lang''-Parameter die gewünschte Sprache angegeben werden: http://gov.genealogy.net/api?information=name&id=KETORFJO70XW&lang=pol
			* ''information=data'' liefert die kompletten Informationen in JSON: http://gov.genealogy.net/api?information=data&id=SCHERGJO54EJ

	* Man kann mit mit ''information=position'' die geografische Position einen Ortes erfragen: http://gov.genealogy.net/api?information=position&id=SCHERGJO54EJ		Formale Dokumentation aller Parameter nach dem '=' in ''information='' siehe https://gov-dev.genealogy.net/swagger-ui/index.html.
	* Den Namen zu einer GOV-ID kann man mit '~~'information~~=~~name~~'~~' erfahren: http://gov.genealogy.net/api?information=name&id=SCHERGJO54EJ~~
	* Bei Orten mit Namen in ~~mehreren Sprachen kann mit Hilfe des~~ ''~~lang''-Parameters angegeben werden, welche Sprache man haben möchte: http://gov.genealogy.net/api?~~information=~~name&id=KETORFJO70XW&lang=pol~~
	* Um die kompletten Informationen in JSON zu bekommen, kann man ''~~information=data'' verwenden: http://gov.genealogy.net/api?information=data&id=SCHERGJO54EJ~~

	~~Eine formale Dokumentation dieser API ist probeweise unter~~ https://gov-dev.genealogy.net/swagger-ui/index.html ~~zu finden~~.

	== SOAP API ==		== SOAP API ==
	Es gibt drei Webservices~~, die auf SOAP~~<ref>{{Wikipedia-Link\|SOAP}}</ref> ~~basieren~~		Es gibt drei SOAP-Webservices<ref>:{{Wikipedia-Link\|SOAP}}</ref>
	* SimpleService - als Suchergebnis werden Listen mit GOV-Kennungen zurück geliefert		* SimpleService - als Suchergebnis werden Listen mit GOV-Kennungen zurück geliefert
	* ComplexService - als Suchergebnis werden Listen zurück geliefert, die die Objekte selbst enthalten		* ComplexService - als Suchergebnis werden Listen zurück geliefert, die die Objekte selbst enthalten
Zeile 32:		Zeile 31:
	Unter Listen sind hier XML-Strukturen zu verstehen, die mit beschreibenden Tags versehen sind. Die Bedeutung der Tags entspricht der englischen Bedeutung der korrespondierenden [[GOV/Quicktext\|Quicktext]]-Elemente.		Unter Listen sind hier XML-Strukturen zu verstehen, die mit beschreibenden Tags versehen sind. Die Bedeutung der Tags entspricht der englischen Bedeutung der korrespondierenden [[GOV/Quicktext\|Quicktext]]-Elemente.

	~~Derzeit (Juni 2017) entsteht eine~~ Dokumentation im genealogy.net Forum: http://forum.genealogy.net/?page=Thread&postID=389371 ~~Wenn alle Operationen beschrieben und Fragen geklärt sind, wird die Dokumentation hierher übernommen.~~		Weitere Dokumentation im genealogy.net Forum: http://forum.genealogy.net/?page=Thread&postID=389371

	=== Lesezugriff ===		=== Lesezugriff ===
Zeile 122:		Zeile 121:
	echo "</pre>";		echo "</pre>";
	?></syntaxhighlight>		?></syntaxhighlight>

	==== PHP 7 ====		==== PHP 7 ====
	Falls der SOAP-Client nicht automatisch installiert ist, muss ein Paket nachinstalliert werden:		Falls der SOAP-Client nicht automatisch installiert ist, muss ein Paket nachinstalliert werden:

Jzedlitz: Hinweis auf Open API Dokumentation im Entwicklungsssystem

2023-10-13T10:45:10Z

Hinweis auf Open API Dokumentation im Entwicklungsssystem

← Nächstältere Version		Version vom 13. Oktober 2023, 12:45 Uhr
Zeile 22:		Zeile 22:
	* Um die kompletten Informationen in JSON zu bekommen, kann man ''information=data'' verwenden: http://gov.genealogy.net/api?information=data&id=SCHERGJO54EJ		* Um die kompletten Informationen in JSON zu bekommen, kann man ''information=data'' verwenden: http://gov.genealogy.net/api?information=data&id=SCHERGJO54EJ

	Eine formale Dokumentation dieser API~~, etwa mit Swagger<ref>{{Wikipedia~~-~~Link\|Swagger (Software)}}<~~/~~ref>, ist noch nicht verfügbar~~.		Eine formale Dokumentation dieser API ist probeweise unter https://gov-dev.genealogy.net/swagger-ui/index.html zu finden.

	== SOAP API ==		== SOAP API ==

Hartenthaler: /* Kompatibilität */

2023-10-11T21:15:54Z

Kompatibilität

← Nächstältere Version		Version vom 11. Oktober 2023, 23:15 Uhr
Zeile 92:		Zeile 92:
	\| [[Benutzer:PLingnau\|PLingnau]]		\| [[Benutzer:PLingnau\|PLingnau]]
	\|-		\|-
	\|PHP 5		\|PHP 5 und 7
	\|[[Bild:True.png]]		\|[[Bild:True.png]]
	\|		\|

Hartenthaler: /* REST API */

2023-10-11T21:12:38Z

REST API

← Nächstältere Version		Version vom 11. Oktober 2023, 23:12 Uhr
Zeile 22:		Zeile 22:
	* Um die kompletten Informationen in JSON zu bekommen, kann man ''information=data'' verwenden: http://gov.genealogy.net/api?information=data&id=SCHERGJO54EJ		* Um die kompletten Informationen in JSON zu bekommen, kann man ''information=data'' verwenden: http://gov.genealogy.net/api?information=data&id=SCHERGJO54EJ

	Eine formale Dokumentation ~~der~~ API, etwa mit ~~SWAGGER~~<ref>{{Wikipedia-Link\|Swagger (Software)}}</ref>, ist noch nicht verfügbar.		Eine formale Dokumentation dieser API, etwa mit Swagger<ref>{{Wikipedia-Link\|Swagger (Software)}}</ref>, ist noch nicht verfügbar.

	== SOAP API ==		== SOAP API ==

Hartenthaler: /* REST API */

2023-10-11T21:11:17Z

REST API

← Nächstältere Version		Version vom 11. Oktober 2023, 23:11 Uhr
Zeile 22:		Zeile 22:
	* Um die kompletten Informationen in JSON zu bekommen, kann man ''information=data'' verwenden: http://gov.genealogy.net/api?information=data&id=SCHERGJO54EJ		* Um die kompletten Informationen in JSON zu bekommen, kann man ''information=data'' verwenden: http://gov.genealogy.net/api?information=data&id=SCHERGJO54EJ

	Eine formale Dokumentation der API, etwa mit SWAGGER<ref>{{Wikipedia-Link\|~~SWAGGER~~ (Software)}}</ref>, ist noch nicht verfügbar.		Eine formale Dokumentation der API, etwa mit SWAGGER<ref>{{Wikipedia-Link\|Swagger (Software)}}</ref>, ist noch nicht verfügbar.

	== SOAP API ==		== SOAP API ==

Hartenthaler: /* REST API */

2023-10-11T21:09:03Z

REST API

← Nächstältere Version		Version vom 11. Oktober 2023, 23:09 Uhr
Zeile 22:		Zeile 22:
	* Um die kompletten Informationen in JSON zu bekommen, kann man ''information=data'' verwenden: http://gov.genealogy.net/api?information=data&id=SCHERGJO54EJ		* Um die kompletten Informationen in JSON zu bekommen, kann man ''information=data'' verwenden: http://gov.genealogy.net/api?information=data&id=SCHERGJO54EJ

	Eine formale Dokumentation der API, etwa mit SWAGGER<ref>{{Wikipedia-Link\|SWAGGER}}</ref>, ist noch nicht verfügbar.		Eine formale Dokumentation der API, etwa mit SWAGGER<ref>{{Wikipedia-Link\|SWAGGER (Software)}}</ref>, ist noch nicht verfügbar.

	== SOAP API ==		== SOAP API ==

Hartenthaler: fehlendes SWAGGER ergänzt

2023-10-11T21:07:23Z

fehlendes SWAGGER ergänzt

← Nächstältere Version		Version vom 11. Oktober 2023, 23:07 Uhr
Zeile 21:		Zeile 21:
	* Bei Orten mit Namen in mehreren Sprachen kann mit Hilfe des ''lang''-Parameters angegeben werden, welche Sprache man haben möchte: http://gov.genealogy.net/api?information=name&id=KETORFJO70XW&lang=pol		* Bei Orten mit Namen in mehreren Sprachen kann mit Hilfe des ''lang''-Parameters angegeben werden, welche Sprache man haben möchte: http://gov.genealogy.net/api?information=name&id=KETORFJO70XW&lang=pol
	* Um die kompletten Informationen in JSON zu bekommen, kann man ''information=data'' verwenden: http://gov.genealogy.net/api?information=data&id=SCHERGJO54EJ		* Um die kompletten Informationen in JSON zu bekommen, kann man ''information=data'' verwenden: http://gov.genealogy.net/api?information=data&id=SCHERGJO54EJ

			Eine formale Dokumentation der API, etwa mit SWAGGER<ref>{{Wikipedia-Link\|SWAGGER}}</ref>, ist noch nicht verfügbar.

	== SOAP API ==		== SOAP API ==

Hartenthaler: /* REST API */

2023-10-11T16:19:26Z

REST API

← Nächstältere Version		Version vom 11. Oktober 2023, 18:19 Uhr
Zeile 5:		Zeile 5:
	== Zweck ==		== Zweck ==
	Über Webservices erhält man einen maschinellen Zugriff auf die Daten des GOV, der inhaltlich dem Zugriff über das Webfrontend entspricht. Mit Webservices kann beispielsweise ein geübter Programmierer die Informationen aus GOV in ein genealogisches Programm einbinden. Für das Programm [[webtrees]] ist beispielsweise ein entsprechendes [[Webtrees Handbuch/Anleitung für Webmaster/Erweiterungsmodule\|Erweiterungsmodul]] verfügbar ("[[Webtrees Handbuch/Anleitung für Webmaster/Erweiterungsmodule/vesta gov4webtrees\|vesta gov4webtrees]]").		Über Webservices erhält man einen maschinellen Zugriff auf die Daten des GOV, der inhaltlich dem Zugriff über das Webfrontend entspricht. Mit Webservices kann beispielsweise ein geübter Programmierer die Informationen aus GOV in ein genealogisches Programm einbinden. Für das Programm [[webtrees]] ist beispielsweise ein entsprechendes [[Webtrees Handbuch/Anleitung für Webmaster/Erweiterungsmodule\|Erweiterungsmodul]] verfügbar ("[[Webtrees Handbuch/Anleitung für Webmaster/Erweiterungsmodule/vesta gov4webtrees\|vesta gov4webtrees]]").

			Um die GOV-Webservices zu nutzen ist keine Authentifizierung nötig.

	== Lizenz ==		== Lizenz ==
Zeile 13:		Zeile 15:

	== REST API ==		== REST API ==
	Mit einem einfachen ~~Webabruf~~ kann man per REST<ref>{{Wikipedia-Link\|Representational State Transfer}}</ref> in JSON<ref>{{Wikipedia-Link\|JSON}}</ref> dargestellte Informationen abfragen.		Mit einem einfachen Web-Aufruf kann man per REST<ref>{{Wikipedia-Link\|Representational State Transfer}}</ref> in JSON<ref>{{Wikipedia-Link\|JSON}}</ref> dargestellte Informationen zu einer GOV-ID abfragen.

	* Man kann mit mit ''information=position'' die geografische Position einen Ortes erfragen: http://gov.genealogy.net/api?information=position&id=SCHERGJO54EJ		* Man kann mit mit ''information=position'' die geografische Position einen Ortes erfragen: http://gov.genealogy.net/api?information=position&id=SCHERGJO54EJ
Zeile 20:		Zeile 22:
	* Um die kompletten Informationen in JSON zu bekommen, kann man ''information=data'' verwenden: http://gov.genealogy.net/api?information=data&id=SCHERGJO54EJ		* Um die kompletten Informationen in JSON zu bekommen, kann man ''information=data'' verwenden: http://gov.genealogy.net/api?information=data&id=SCHERGJO54EJ

	== SOAP ~~Webservices~~ ==		== SOAP API ==
	Es gibt drei Webservices, die auf SOAP<ref>{{Wikipedia-Link\|SOAP}}</ref> basieren		Es gibt drei Webservices, die auf SOAP<ref>{{Wikipedia-Link\|SOAP}}</ref> basieren
	* SimpleService - als Suchergebnis werden Listen mit GOV-Kennungen ~~zurückgeliefert~~		* SimpleService - als Suchergebnis werden Listen mit GOV-Kennungen zurück geliefert
	* ComplexService - als Suchergebnis werden Listen ~~zurückgeliefert~~, die die Objekte selbst enthalten		* ComplexService - als Suchergebnis werden Listen zurück geliefert, die die Objekte selbst enthalten
	* ChangeService - mit diesem Dienst können Daten im GOV verändert werden		* ChangeService - mit diesem Dienst können Daten im GOV verändert werden

Zeile 103:		Zeile 105:
	\|[[Bild:True.png]]		\|[[Bild:True.png]]
	\|		\|
	\| ~~Nur~~ das Lesen getestet.		\| nur das Lesen getestet.
	\| [[Benutzer:PLingnau\|PLingnau]]		\| [[Benutzer:PLingnau\|PLingnau]]
	\|}		\|}
Zeile 118:		Zeile 120:
	echo "</pre>";		echo "</pre>";
	?></syntaxhighlight>		?></syntaxhighlight>
	~~Ja, das ist alles! :-)~~

	==== PHP 7 ====		==== PHP 7 ====
	~~Bei PHP 7 ist~~ der ~~Soap~~-Client nicht ~~mehr~~ automatisch ~~dabei~~, ~~zumindest nicht bei Ubuntu. Hier~~ muss ein Paket nachinstalliert werden:		Falls der SOAP-Client nicht automatisch installiert ist, muss ein Paket nachinstalliert werden:
	<source lang="bash">sudo apt-get install php-soap</source>		<source lang="bash">sudo apt-get install php-soap</source>

Hartenthaler: /* REST API */

2023-10-11T16:11:08Z

REST API

← Nächstältere Version		Version vom 11. Oktober 2023, 18:11 Uhr
Zeile 17:		Zeile 17:
	* Man kann mit mit ''information=position'' die geografische Position einen Ortes erfragen: http://gov.genealogy.net/api?information=position&id=SCHERGJO54EJ		* Man kann mit mit ''information=position'' die geografische Position einen Ortes erfragen: http://gov.genealogy.net/api?information=position&id=SCHERGJO54EJ
	* Den Namen zu einer GOV-ID kann man mit ''information=name'' erfahren: http://gov.genealogy.net/api?information=name&id=SCHERGJO54EJ		* Den Namen zu einer GOV-ID kann man mit ''information=name'' erfahren: http://gov.genealogy.net/api?information=name&id=SCHERGJO54EJ
	* Bei Orten mit Namen in mehreren Sprachen kann mit Hilfe des ''lang''-Parameters angegeben werden, welche Sprache man haben möchte: ~~<nowiki>~~http://gov.genealogy.net/api?i…&id=KETORFJO70XW&lang=pol~~</nowiki>~~		* Bei Orten mit Namen in mehreren Sprachen kann mit Hilfe des ''lang''-Parameters angegeben werden, welche Sprache man haben möchte: http://gov.genealogy.net/api?information=name&id=KETORFJO70XW&lang=pol
	* ~~Und sogar~~ die kompletten Informationen ~~kann man~~ in JSON bekommen, ~~indem~~ man information=data ~~verwendet~~: ~~<nowiki>~~http://gov.genealogy.net/api?~~i…tion~~=data&id=SCHERGJO54EJ~~</nowiki>~~		* Um die kompletten Informationen in JSON zu bekommen, kann man ''information=data'' verwenden: http://gov.genealogy.net/api?information=data&id=SCHERGJO54EJ

	== SOAP Webservices ==		== SOAP Webservices ==