Die API ist geschützt und kann nur aufgerufen werden, wenn die Anfrage mithilfe eines API-Schlüssels authentifiziert wird. Dieser muss bei jeder Anfrage als Bearer-Token im Authorization-Header angegeben werden. Wende dich an support@ginto.guide, um einen API-Schlüssel für die API-Autorisierung zu erhalten.
Wenn du bereits eine Schnittstelle zu einem unserer Partnerorganisationen hast, zum Beispiel zum AccommoDataHub von Hotellerie Suisse, kannst du einige Informationen auch von dort beziehen.
Nutze unseren Ginto-Test-Workspace in Postman, um die verschiedenen Abfragen zu testen.
Ginto stellt zwei GraphQL-Endpunkte bereit. Einen für die produktive Umgebung und einen für die Testumgebung.
Endpunkt für die produktive Umgebung.
POST api.ginto.guide/graphql
Endpunkt für die Testumgebung:
POST api.dev.ginto.guide/graphql
Die API ist geschützt. Ein Zugriff ist nur möglich, wenn die Anfrage mithilfe eines API-Schlüssels authentifiziert wird.
Der API-Schlüssel muss bei jeder Anfrage als Bearer Token im Authorization-Header bereitgestellt werden:
Authorization: Bearer {token}Der API-Schlüssel kann durch eine kurze Nachricht an support@ginto.guide angefordert werden.
Postman ist ein bekanntes Werkzeug zur Erstellung und Verwendung von APIs. Es bietet eine gute Möglichkeit, die Ginto-GraphQL-API zu erkunden und zu testen.
.png)
Postman kann online genutzt und kostenlos heruntergeladen werden. Hier findest du eine detaillierte Anleitung zur Erstellung von GraphQL-Abfragen.
GraphQL bietet ein typisiertes Schema für die Daten. Dank der Introspektionsfunktion ist die Dokumentation direkt in das Schema integriert. Diese gibt Auskunft darüber, welche Abfragen unterstützt werden. Für fast alle relevanten Programmiersprachen sind Client-Bibliotheken verfügbar. GraphQL kann mit einer normalen HTTP-Anfrage verwendet werden. API-Entwicklungswerkzeuge wie Postman unterstützen GraphQL standardmäßig.
Aus Gründen der Leistung und Skalierung ist die Anzahl der zurückgegebenen Einträge pro Anfrage begrenzt. Es gibt einen Paginierungsmechanismus, der es ermöglicht, über eine Cursor-Pased-Paginierung zum nächsten Stapel von Einträgen zu springen.
Das Konzept basiert auf Verbindungen und Kanten, die in GraphQL ein Quasi-Standard für die Paginierung sind. Bei Abfragen, die eine Paginierung ermöglichen, können die Argumente first und after sowie eine angeforderte pageInfo festgelegt werden. Das erste Argument definiert, wie viele Elemente mit der Anfrage zurückgegeben werden sollen. Aus Leistungsgründen darf dieser Wert nicht höher als 50 sein. Die pageInfo enthält einen endCursor, der den Cursor des letzten Elements auf der Seite definiert. Dieser endCursor kann dann für das after-Argument der nächsten Anfrage verwendet werden, um die nachfolgenden Elemente nach dem endCursor zu erhalten. Die Parameter zur Steuerung der Seitennummerierung sind im Schema dokumentiert.
Für die erste Seite muss kein after-Argument festgelegt werden. Die folgende Anfrage gibt die ersten 50 Einträge zusammen mit einer pageInfo zurück, die den endCursor der Seite enthält.
{
allEntries(first: 50) {
totalCount
pageInfo {
hasNextPage
endCursor
}
edges {
node {
id
name
}
}
}
}
Um die nächsten 50 Einträge anzufordern, nehmen wir den endCursor der vorherigen Antwort und setzen ihn wie folgt für das After-Argument der nächsten Anforderung:
{
allEntries(first: 50, after: "NTA") {
totalCount
pageInfo {
hasNextPage
endCursor
}
edges {
node {
id
name
}
}
}
}Die Standardsprache der zurückgegebenen Daten kann eingestellt werden. Derzeit werden die Sprachen Deutsch, Französisch, Italienisch und Englisch unterstützt.
Die Standardsprache der zurückgegebenen Daten kann durch setzen des HTTP-Headers Accept-Language ausgewählt werden. Derzeit werden die Optionen de (Deutsch), en (Englisch), fr (Französisch) und it (Italienisch) unterstützt.
Hier findest du weitere Informationen zum HTTP header Accept-Language.
Bei Texten, die in mehreren Sprachen verfügbar sind, kann auch über das Feld Argument eine bestimmte Sprache festgelegt werden.
Alle Einträge abrufen.
{
allEntries {
totalCount
pageInfo {
hasNextPage
endCursor
}
edges {
node {
id
sourceIds(sourceKey: "zuerst") // at the moment only available for business users
name
position {
street
housenumber
postcode
city
lat
lng
}
externalRatings(sourceKey: "zuerst") {
iconUrl
descriptionDE: description(locale: DE)
descriptionFR: description(locale: FR)
descriptionIT: description(locale: IT)
descriptionEN: description(locale: EN)
grade
}
publication {
iconUrl
iconTextDE: iconText(locale: DE)
iconTextFR: iconText(locale: FR)
iconTextIT: iconText(locale: IT)
iconTextEN: iconText(locale: EN)
linkUrl
linkTextDE: linkText(locale: DE)
linkTextFR: linkText(locale: FR)
linkTextIT: linkText(locale: IT)
linkTextEN: linkText(locale: EN)
}
}
}
}
}Abrufen eines bestimmten Eintrags anhand der ID.
{
entry(entryId: "ee659e74-295f-4285-8c3d-d90f232efa44") {
entryId
name
externalRatings(sourceKey: "zuerst") {
iconUrl
description
grade
}
publication {
linkUrl
linkText
}
licenseInfo {
license
attribution
isOpenData
}
manualWheelchairAccessibility: accessibility(ratingProfileId: "Z2lkOi8vcmFpbHMtYXBwL1JhdGluZ1Byb2ZpbGVzOjpSYXRpbmdQcm9maWxlLzc4") {
grade
conformance
}
powerWheelchairAccessibility: accessibility(ratingProfileId: "Z2lkOi8vcmFpbHMtYXBwL1JhdGluZ1Byb2ZpbGVzOjpSYXRpbmdQcm9maWxlLzc5") {
grade
conformance
}
pushchairAccessibility: accessibility(ratingProfileId: "Z2lkOi8vcmFpbHMtYXBwL1JhdGluZ1Byb2ZpbGVzOjpSYXRpbmdQcm9maWxlLzgw") {
grade
conformance
}
}
}Einträge nach Koordinaten und Namen abrufen.
{
entriesBySearch(lat: 47.4224806, lng: 9.3760095, query: "palace", within: 5) {
totalCount
pageInfo {
hasNextPage
endCursor
}
edges {
node {
id
name
position {
street
housenumber
postcode
city
lat
lng
}
publication {
iconUrl
iconTextDE: iconText(locale: DE)
iconTextFR: iconText(locale: FR)
iconTextIT: iconText(locale: IT)
iconTextEN: iconText(locale: EN)
linkUrl
linkTextDE: linkText(locale: DE)
linkTextFR: linkText(locale: FR)
linkTextIT: linkText(locale: IT)
linkTextEN: linkText(locale: EN)
}
}
}
}
}To request the next 50 entries we take the endCursor of the previous response and set it for the after argument of the next request as follows:
Über die API können Einträge anhand definierter Filter abgefragt werden. Für jedes Benutzerkonto können dynamisch individuelle Eingabefilter konfiguriert werden. Es kann nach Kategorien, Quellen, Qualitätsstufen, Postleitzahlen, geografischen Grenzen, Bewertungsprofilen oder manuell hinzugefügten Einträgen gefiltert werden.
{
entriesByFilter(filterId: "Z2lkOi8vcmFpbHMtYXBwL0dyb3VwaW5nOjpFbnRyeUdyb3VwL2U2Y2I1ZTU4LTE0MDQtNDk5Mi05YjY1LTlkNjc1MTJmZTRiMg", first: 50, after: "NTA") {
totalCount
pageInfo {
hasNextPage
endCursor
}
edges {
node {
id
sourceIds(sourceKey: "parks.swiss") // at the moment only available for business users
name
externalRatings(sourceKey: "zuerst") {
iconUrl
description
grade
}
publication {
iconUrl
iconText
linkUrl
linkText
}
licenseInfo {
license
attribution
isOpenData
}
wheelchairAccessibility: accessibility(ratingProfileId: "Z2lkOi8vcmFpbHMtYXBwL1JhdGluZ1Byb2ZpbGVzOjpSYXRpbmdQcm9maWxlLzc4") {
grade
conformance
}
}
}
}
}
Im folgenden Beispiel werden alle Eingabefilter abgerufen, für die ein:e Nutzer:in berechtigt ist. Die ID kann dann für die Abfrage entriesByFilter verwendet werden.
{
entryFilters {
id
name
createdAt
updatedAt
categoryKeys
sources
qualityLevels
postcodes
}
}
Liste mit Quell-ID und Piktogrammen, Name, Link gemäss Importliste
Code
So wie bei PI jetzt
Profile
{
ratingProfiles {
id
name
}
}Outro
Intro
siehe auch E-Mail von Julian an MC von G vom 16. Oktober 2024
Outro - RichText
