Documentation technique

Appels enrichis

Il est possible de récupérer un objet touristique enrichi des informations fournies par des partenaires d’Apidae

Ces enrichissements se basent sur des données préalablement liées en métadonnée pour lesquelles Apidae va ensuite collecter la donnée finale afin d’être en mesure de la livrer en un seul appel.

Les enrichissements ne sont disponibles qu’en API, ils sont livrés dans des nœuds identifiés en fin de flux JSON.

Appels disponibles en pré-version !

Attention, cette fonctionnalité est actuellement fournie en version Beta
Ses fonctionnalités et le endpoint sont appelés à évoluer

Attention
  • Le domaine api.plateforme.apidae-tourisme.com est différent du domaine utilisé pour les autres appels
  • Seul l’enrichissement du multi-horaire est disponible aujourd’hui
  • Les disponiblités Avizi et Apidae Photo seront disponibles prochainement

https://api.plateforme.apidae-tourisme.com/apidae/objetenrich/?id={id}&apiKey={apiKey}&projetId={projetId}&enrichments={multihoraire}

Description
Méthode GET

{id} est l’identifiant numérique de l’objet à récupérer
callback (optionnel) : nom de la fonction de callback (pour JSONP)
responseFields (optionnel) : cf. Filtrage des données
locales : cf. Filtrage des langues
apiKey : clé d’API
projetId : identifiant du projet
enrichments : liste des enrichissements souhaités, séparés par une virgule

Aperçu
avec tous les paramètres

https://api.plateforme.apidae-tourisme.com/apidae/objetenrich/?id={id}&callback={callback}&responseFields={responseFields}&locales={locales}&apiKey={apiKey}&projetId={projetId}&enrichments={enrichissements}

Exemple

https://api.plateforme.apidae-tourisme.com/apidae/objetenrich/?id=5340901&apiKey=XXXXX&projetId=12345&responseFields=id,nom&locales=fr,en&enrichments=multihoraire

Format de sortie

> Documentation format des objets touristiques (format JSON)

Les données enrichies sont livrées à la suite des données touristiques. Ces données sont au format dans lequel le fourni leur propriétaire.

Enrichissements

multihoraire : fournit les données liées aux périodes du multi-horaire. Consulter le format du multi-horaire pour plus de détails.
À venir prochainement : disponibilités Avizi, Apidae Photos…

Cas d’erreur

Erreur 404 : objet non trouvé ; le corps de la réponse HTTP contient le message d’erreur au format texte.
Erreur 50x : erreur de traitement ; le corps de la réponse HTTP contient le message d’erreur au format texte.
Unalowed enrichments : Erreur dans le nom d’un partenaire. Le partenaire n’est pas reconnu.

Exemple de réponse

{
    "type": "ACTIVITE",
    "id": 5340901,
    "nom": {
        "libelleFr": "ANNULE - Atelier créations végétales / terrarium"
    },
    "ouverture": {
        "periodesOuvertures": [
            {
                "identifiantTechnique": 20376522
            },
            {
                "identifiantTechnique": 20376523
            }
        ]
    },
    "multihoraire": [
        {
            "startDate": "2020-09-12",
            "endDate": "2020-09-12",
            "timePeriods": [
                {
                    "timeFrames": [
                        {
                            "recurrence": null,
                            "endTime": "12:30",
                            "startTime": "10:30"
                        }
                    ],
                    "labels": {
                        "ru": "часы открытия",
                        "fr": "Ouverture",
                        "en": "Opening hours",
                        "nl": "Openingstijden",
                        "de": "Öffnungszeiten",
                        "it": "Orari di apertura",
                        "pt-br": "Horário de abertura",
                        "zh": "开放时间",
                        "ja": "開館時間",
                        "es": "Horarios de apertura"
                    },
                    "type": "opening",
                    "weekdays": [
                        "SAT"
                    ]
                }
            ],
            "externalType": "ACTIVITE",
            "externalRef": 5340901,
            "externalId": 20376522,
            "updatedAt": 1611245091733,
            "type": "apidae_period"
        }
    ],
    "timestamp": 1632385421469
}