L'API est protégée et ne peut être invoquée que si la demande est authentifiée à l'aide d'une clé API. Cela doit être spécifié en tant que jeton porteur dans l'en-tête d'autorisation à chaque demande. Contactez support@ginto.guide pour obtenir une clé d'API pour l'autorisation de l'API.
Si vous disposez déjà d'une interface avec l'une de nos organisations partenaires, par exemple l'AccommoDataHub d'Hotellerie Suisse, vous pouvez également y obtenir des informations.
Utilisez notre espace de travail de test Ginto dans Postman pour tester les différentes requêtes.
Ginto fournit deux points de terminaison GraphQL. Un pour l'environnement de production et un pour l'environnement de test.
Point final de l'environnement de production.
POST api.ginto.guide/graphql
Point final de l'environnement de test :
POST api.dev.ginto.guide/graphql
Hier wird die Datenstruktur erklärt: Wie sollen Daten beispielsweise von Räumen, Wegen, Icons, Auswertungen etc. von der API genutzt und integriert werden?
nach
L'API est protégée. L'accès n'est possible que si la demande est authentifiée à l'aide d'une clé API.
Pour chaque demande, la clé API doit être Jeton Bearer Les informations suivantes sont fournies dans l'en-tête Authorization :
Authorization: Bearer {token}La clé API peut être demandée en envoyant un court message à support@ginto.guide.
Postman est un outil bien connu pour créer et utiliser des API. C'est un bon moyen d'explorer et de tester l'API Ginto-GraphQL.
.png)
Le facteur peut utilisé en ligne et téléchargé gratuitement devenir. Vous trouverez ici un instructions détaillées pour créer des requêtes GraphQL.
GraphQL fournit un schéma typé pour les données. Grâce à la fonction d'introspection, la documentation est intégrée directement dans le schéma. Cela fournit des informations sur les requêtes prises en charge. Les bibliothèques clientes sont disponibles pour presque tous les langages de programmation pertinents. GraphQL peut être utilisé avec une requête HTTP normale. Les outils de développement d'API tels que Postman prennent en charge GraphQL dès sa sortie de l'emballage.
Pour des raisons de performances et d'échelle, le nombre d'entrées renvoyées par demande est limité. Il existe un mécanisme de pagination qui permet de passer au lot d'entrées suivant via une pagination par curseur.
Le concept est basé sur les connexions et les arêtes, qui constituent un quasi-standard pour la pagination dans GraphQL. Pour les requêtes qui autorisent la pagination, les arguments peuvent D'abord et Après ainsi qu'une demande Informations sur la page être défini. Le premier argument définit le nombre d'éléments qui doivent être renvoyés avec la demande. Pour des raisons de performance, cette valeur ne doit pas dépasser 50. Mourez Informations sur la page contient un Curseur de finqui curseur Défini le dernier élément de la page. Ce Curseur de fin Peut alors pour Aprèsl'argument de la requête suivante peut être utilisé pour ajouter les éléments suivants après Curseur de fin recevoir. Les paramètres de contrôle de la numérotation des pages sont documentés dans le diagramme.
Pour la première page, non Aprèsl'argument peut être défini. La requête suivante renvoie les 50 premières entrées ainsi qu'un Informations sur la page Souligne que le Curseur de fin la page contient.
{
allEntries(first: 50) {
totalCount
pageInfo {
hasNextPage
endCursor
}
edges {
node {
id
name
}
}
}
}
Pour demander les 50 prochaines entrées, nous utilisons Curseur de fin la réponse précédente et définissez-la comme suit pour l'argument after de la requête suivante :
{
allEntries(first: 50, after: "NTA") {
totalCount
pageInfo {
hasNextPage
endCursor
}
edges {
node {
id
name
}
}
}
}
La langue par défaut des données renvoyées peut être définie. Les langues allemand, français, italien et anglais sont actuellement prises en charge.
La langue par défaut des données renvoyées peut être définie en définissant l'en-tête HTTP Langue d'acceptation être sélectionné. Actuellement, les options sont de (allemand), en (anglais), fr (français) et it (italien) supports.
Vous trouverez ici plus d'informations sur En-tête HTTP Accept-Language.
Pour les textes disponibles en plusieurs langues, une langue spécifique peut également être définie à l'aide du champ Argument.
Récupérez toutes les entrées.
{
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)
}
}
}
}
}Récupérez une entrée spécifique en fonction de l'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
}
}
}L'API permet d'interroger les entrées à l'aide de filtres définis. Les filtres de saisie individuels peuvent être configurés dynamiquement pour chaque compte utilisateur. Il peut être filtré par catégories, sources, niveaux de qualité, codes postaux, limites géographiques, profils de notation ou annonces ajoutées manuellement.
{
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
}
}
}
}
}
L'exemple suivant récupère tous les filtres d'entrée pour lesquels un utilisateur est autorisé. L'ID peut ensuite être utilisé pour la requête EntriesByFilter.
{
entryFilters {
id
name
createdAt
updatedAt
categoryKeys
sources
qualityLevels
postcodes
}
}
Récupérez les entrées par coordonnées et par noms.
{
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)
}
}
}
}
}Pour demander les 50 entrées suivantes, nous prenons le endCursor de la réponse précédente et le définissons comme argument after de la requête suivante comme suit :
Toutes les entrées sont attribuées à une catégorie (par exemple « Hôtel ») et à un groupe de catégories de niveau supérieur (par exemple « Hébergement »).
Cela vous donne un aperçu de toutes les catégories et groupes de catégories disponibles :
AllEntries {
availableCategories {
groupKey
groupName
key
name
}
}
Voici comment obtenir la catégorie et le groupe de catégories d'une entrée spécifique :
AllEntries {
entry(entryId: "8f62bea4-b778-46e2-ac49-dda6a4ef2680") {
name
categories {
groupKey
groupName
key
name
}
}
