Aller au contenu

RecraHub Public API

Aperçu. Le contrat v1 peut changer avant la disponibilité générale. Ancrez les intégrations sur openapi.json et suivez cette page.

Schéma OpenAPI · https://www.recrahub.nl/api/v1

GET /properties/{property-id}/programmes/current-or-next

Renvoie le programme publié à la date de sélection, ou le prochain programme publié s'il n'y en a pas ce jour-là.

Paramètres de requête

Paramètre Description
lang Facultatif. Les valeurs prises en charge dépendent des langues de l’établissement. Les champs traduisibles incluent nl, en, de, fr et localized. Localized utilise la langue demandée lorsqu’elle est disponible et se replie sur le néerlandais.
date Facultatif. Date de sélection au format YYYY-MM-DD. Par défaut, aujourd’hui dans le fuseau horaire de l’établissement.

Exemples de requêtes

Programme actuel ou suivant

GET /properties/{property-id}/programmes/current-or-next

Programme actuel ou suivant pour une date

GET /properties/{property-id}/programmes/current-or-next?date=2026-07-01

Valeurs localisées en anglais

GET /properties/{property-id}/programmes/current-or-next?lang=en

Réponses

200 OK

Payload de programme avec champs du programme, days, highlights et more_info.

Réponse

{
  "id": 48,
  "name": "Week 27",
  "title": {
    "nl": "Recreatieprogramma",
    "en": "Recreation programme",
    "de": null,
    "fr": null,
    "localized": "Recreation programme"
  },
  "start_date": "2026-07-06",
  "end_date": "2026-07-12",
  "urls": { "api": "https://example.com/api/v1/properties/12/programmes/48" },
  "theme": {
    "id": 7,
    "name": {
      "nl": "Zomer",
      "en": "Summer",
      "de": null,
      "fr": null,
      "localized": "Summer"
    },
    "description": {
      "nl": "Zomerse week",
      "en": "Summer week",
      "de": null,
      "fr": null,
      "localized": "Summer week"
    },
    "image_url": "https://example.com/storage/themes/summer.jpg",
    "highlighted": true
  },
  "days": [
    {
      "day": 1,
      "date": "2026-07-06",
      "activities": [
        {
          "id": 901,
          "name": {
            "nl": "Kinderdisco",
            "en": "Kids disco",
            "de": null,
            "fr": null,
            "localized": "Kids disco"
          },
          "starts_at": "2026-07-06T10:00:00+02:00",
          "category": {
            "id": 3,
            "name": {
              "nl": "Sport",
              "en": "Sport",
              "de": null,
              "fr": null,
              "localized": "Sport"
            },
            "explanation": {
              "nl": "Activiteiten waarbij je actief beweegt.",
              "en": "Activities where you move actively.",
              "de": null,
              "fr": null,
              "localized": "Activities where you move actively."
            },
            "cta": {
              "nl": "Doe mee",
              "en": "Join",
              "de": null,
              "fr": null,
              "localized": "Join"
            },
            "image_url": "https://example.com/storage/categories/sport.png"
          },
          "link": {
            "url": { "nl": "https://example.com/activity-info", "en": "https://example.com/en/activity-info", "de": null, "fr": null, "localized": "https://example.com/en/activity-info" },
            "label": { "nl": "Meer info", "en": "More info", "de": null, "fr": null, "localized": "More info" }
          },
          "signup": { "enabled": true, "status": "open" }
        }
      ]
    }
  ],
  "highlights": [
    {
      "type": "activity",
      "id": 34,
      "name": {
        "nl": "Disco avond",
        "en": "Disco night",
        "de": null,
        "fr": null,
        "localized": "Disco night"
      },
      "header": {
        "nl": "Vandaag uitgelicht",
        "en": "Highlighted today",
        "de": null,
        "fr": null,
        "localized": "Highlighted today"
      },
      "description": {
        "nl": "Kom dansen met het animatieteam.",
        "en": "Come dance with the entertainment team.",
        "de": null,
        "fr": null,
        "localized": "Come dance with the entertainment team."
      },
      "image_url": "https://example.com/storage/highlights/disco.jpg",
      "program_activity_id": 901
    }
  ],
  "more_info": {
    "explanation_categories": [
      {
        "id": 3,
        "name": {
          "nl": "Sport",
          "en": "Sport",
          "de": null,
          "fr": null,
          "localized": "Sport"
        },
        "explanation": {
          "nl": "Activiteiten waarbij je actief beweegt.",
          "en": "Activities where you move actively.",
          "de": null,
          "fr": null,
          "localized": "Activities where you move actively."
        },
        "cta": {
          "nl": "Doe mee",
          "en": "Join",
          "de": null,
          "fr": null,
          "localized": "Join"
        },
        "image_url": "https://example.com/storage/categories/sport.png"
      }
    ],
    "explanation_footer_text": {
      "nl": "Programma onder voorbehoud.",
      "en": "Programme subject to change.",
      "de": null,
      "fr": null,
      "localized": "Programme subject to change."
    },
    "online": {
      "enabled": true,
      "url": "https://example.com/demo-park",
      "show_recrateam_logo": true,
      "recrateam_logo_url": "https://example.com/images/logo-recrateam.svg"
    },
    "practical_information": [
      {
        "icon": "info",
        "text": {
          "nl": "Verzamelen bij de receptie.",
          "en": "Meet at reception.",
          "de": null,
          "fr": null,
          "localized": "Meet at reception."
        }
      }
    ]
  }
}
404 Introuvable

Aucun programme publié pour cet établissement et cette date (et aucun programme ultérieur).

422 Erreur de validation

Valeur de requête lang ou date invalide.

GET /properties/{property-id}/programmes/{program-id}

Renvoie un programme publié par id. Le programme doit appartenir à l'établissement du chemin.

Paramètres de requête

Paramètre Description
lang Facultatif. Les valeurs prises en charge dépendent des langues de l’établissement. Les champs traduisibles incluent nl, en, de, fr et localized. Localized utilise la langue demandée lorsqu’elle est disponible et se replie sur le néerlandais.

Exemples de requêtes

Programme par ID

GET /properties/{property-id}/programmes/{program-id}

Programme par ID avec valeurs localisées

GET /properties/{property-id}/programmes/{program-id}?lang=de

Réponses

200 OK

Payload de programme avec champs du programme, days, highlights et more_info.

Réponse

{
  "id": 48,
  "name": "Week 27",
  "title": {
    "nl": "Recreatieprogramma",
    "en": "Recreation programme",
    "de": null,
    "fr": null,
    "localized": "Recreation programme"
  },
  "start_date": "2026-07-06",
  "end_date": "2026-07-12",
  "urls": { "api": "https://example.com/api/v1/properties/12/programmes/48" },
  "theme": {
    "id": 7,
    "name": {
      "nl": "Zomer",
      "en": "Summer",
      "de": null,
      "fr": null,
      "localized": "Summer"
    },
    "description": {
      "nl": "Zomerse week",
      "en": "Summer week",
      "de": null,
      "fr": null,
      "localized": "Summer week"
    },
    "image_url": "https://example.com/storage/themes/summer.jpg",
    "highlighted": true
  },
  "days": [
    {
      "day": 1,
      "date": "2026-07-06",
      "activities": [
        {
          "id": 901,
          "name": {
            "nl": "Kinderdisco",
            "en": "Kids disco",
            "de": null,
            "fr": null,
            "localized": "Kids disco"
          },
          "starts_at": "2026-07-06T10:00:00+02:00",
          "category": {
            "id": 3,
            "name": {
              "nl": "Sport",
              "en": "Sport",
              "de": null,
              "fr": null,
              "localized": "Sport"
            },
            "explanation": {
              "nl": "Activiteiten waarbij je actief beweegt.",
              "en": "Activities where you move actively.",
              "de": null,
              "fr": null,
              "localized": "Activities where you move actively."
            },
            "cta": {
              "nl": "Doe mee",
              "en": "Join",
              "de": null,
              "fr": null,
              "localized": "Join"
            },
            "image_url": "https://example.com/storage/categories/sport.png"
          },
          "link": {
            "url": { "nl": "https://example.com/activity-info", "en": "https://example.com/en/activity-info", "de": null, "fr": null, "localized": "https://example.com/en/activity-info" },
            "label": { "nl": "Meer info", "en": "More info", "de": null, "fr": null, "localized": "More info" }
          },
          "signup": { "enabled": true, "status": "open" }
        }
      ]
    }
  ],
  "highlights": [
    {
      "type": "activity",
      "id": 34,
      "name": {
        "nl": "Disco avond",
        "en": "Disco night",
        "de": null,
        "fr": null,
        "localized": "Disco night"
      },
      "header": {
        "nl": "Vandaag uitgelicht",
        "en": "Highlighted today",
        "de": null,
        "fr": null,
        "localized": "Highlighted today"
      },
      "description": {
        "nl": "Kom dansen met het animatieteam.",
        "en": "Come dance with the entertainment team.",
        "de": null,
        "fr": null,
        "localized": "Come dance with the entertainment team."
      },
      "image_url": "https://example.com/storage/highlights/disco.jpg",
      "program_activity_id": 901
    }
  ],
  "more_info": {
    "explanation_categories": [
      {
        "id": 3,
        "name": {
          "nl": "Sport",
          "en": "Sport",
          "de": null,
          "fr": null,
          "localized": "Sport"
        },
        "explanation": {
          "nl": "Activiteiten waarbij je actief beweegt.",
          "en": "Activities where you move actively.",
          "de": null,
          "fr": null,
          "localized": "Activities where you move actively."
        },
        "cta": {
          "nl": "Doe mee",
          "en": "Join",
          "de": null,
          "fr": null,
          "localized": "Join"
        },
        "image_url": "https://example.com/storage/categories/sport.png"
      }
    ],
    "explanation_footer_text": {
      "nl": "Programma onder voorbehoud.",
      "en": "Programme subject to change.",
      "de": null,
      "fr": null,
      "localized": "Programme subject to change."
    },
    "online": {
      "enabled": true,
      "url": "https://example.com/demo-park",
      "show_recrateam_logo": true,
      "recrateam_logo_url": "https://example.com/images/logo-recrateam.svg"
    },
    "practical_information": [
      {
        "icon": "info",
        "text": {
          "nl": "Verzamelen bij de receptie.",
          "en": "Meet at reception.",
          "de": null,
          "fr": null,
          "localized": "Meet at reception."
        }
      }
    ]
  }
}
404 Introuvable

Le programme n'existe pas, n'est pas publié ou appartient à un autre établissement.

422 Erreur de validation

Valeur de requête lang invalide.

GET /properties/{property-id}/age-tags

Renvoie les tags d'âge réellement utilisés par les programmes publiés d'un établissement public.

Paramètres de requête

Paramètre Description
lang Facultatif. Les valeurs prises en charge dépendent des langues de l’établissement. Les champs traduisibles incluent nl, en, de, fr et localized. Localized utilise la langue demandée lorsqu’elle est disponible et se replie sur le néerlandais.

Exemples de requêtes

Tags d'âge utilisés

GET /properties/{property-id}/age-tags

Valeurs localisées en anglais

GET /properties/{property-id}/age-tags?lang=en

Réponses

200 OK

Tableau JSON d'objets tag d'âge avec la même structure de texte que les valeurs age_tag des activités de programme.

Réponse

[
  {
    "id": 5,
    "name": {
      "nl": "Alle leeftijden",
      "en": "All ages",
      "de": null,
      "fr": null,
      "localized": "All ages"
    }
  }
]
404 Introuvable

L’établissement n’existe pas ou n’est pas public.

422 Erreur de validation

Valeur de requête lang invalide.

GET /properties/{property-id}/areas

Renvoie les lieux réellement utilisés par les programmes publiés d'un établissement public.

Paramètres de requête

Paramètre Description
lang Facultatif. Les valeurs prises en charge dépendent des langues de l’établissement. Les champs traduisibles incluent nl, en, de, fr et localized. Localized utilise la langue demandée lorsqu’elle est disponible et se replie sur le néerlandais.

Exemples de requêtes

Lieux utilisés

GET /properties/{property-id}/areas

Valeurs localisées en allemand

GET /properties/{property-id}/areas?lang=de

Réponses

200 OK

Tableau JSON d'objets lieu avec la même structure de texte que les valeurs area des activités de programme.

Réponse

[
  {
    "id": 8,
    "name": {
      "nl": "Sportveld",
      "en": "Sports field",
      "de": "Sportplatz",
      "fr": null,
      "localized": "Sportplatz"
    }
  }
]
404 Introuvable

L’établissement n’existe pas ou n’est pas public.

422 Erreur de validation

Valeur de requête lang invalide.

GET /properties

Tous les établissements avec show_on_website. Pour l'intégration et les cartes publiques.

Exemples de requêtes

Lister les établissements publics

GET /properties

Réponses

200 OK

Tableau JSON d’objets établissement publics avec id, slug, nom, adresse formatée, coordonnées, URL publique, URL du logo et URL de l’image d’en-tête.

Réponse

[
  {
    "id": 12,
    "slug": "demo-park",
    "name": "Demo Park",
    "formatted_address": "Example Street 1, 1234 AB Amsterdam",
    "coordinates": { "lat": 52.37, "lng": 4.89 },
    "url": "https://example.com/demo-park",
    "logo_url": "https://example.com/storage/properties/logos/demo.png",
    "header_image_url": "https://example.com/storage/properties/headers/demo.jpg"
  }
]

GET /properties/{property-id}

Renvoie les détails publics d’un établissement par id. Préférez cet endpoint pour les intégrations enregistrées, car les ids ne changent pas lorsqu’un slug change.

Exemples de requêtes

Établissement par ID

GET /properties/{property-id}

Réponses

200 OK

Objet établissement public avec id, slug, nom, adresse formatée, coordonnées, URL publique, URL du logo et URL de l’image d’en-tête.

Réponse

{
  "id": 12,
  "slug": "demo-park",
  "name": "Demo Park",
  "formatted_address": "Example Street 1, 1234 AB Amsterdam",
  "coordinates": { "lat": 52.37, "lng": 4.89 },
  "url": "https://example.com/demo-park",
  "logo_url": "https://example.com/storage/properties/logos/demo.png",
  "header_image_url": "https://example.com/storage/properties/headers/demo.jpg"
}
404 Introuvable

L’établissement n’existe pas ou n’est pas public.

GET /properties/by-slug/{property-slug}

Renvoie les détails publics d’un établissement par slug. Utilisez-le pour la découverte ou les liens destinés aux utilisateurs ; préférez l’id pour les intégrations enregistrées.

Exemples de requêtes

Établissement par slug

GET /properties/by-slug/{property-slug}

Réponses

200 OK

Objet établissement public avec id, slug, nom, adresse formatée, coordonnées, URL publique, URL du logo et URL de l’image d’en-tête.

Réponse

{
  "id": 12,
  "slug": "demo-park",
  "name": "Demo Park",
  "formatted_address": "Example Street 1, 1234 AB Amsterdam",
  "coordinates": { "lat": 52.37, "lng": 4.89 },
  "url": "https://example.com/demo-park",
  "logo_url": "https://example.com/storage/properties/logos/demo.png",
  "header_image_url": "https://example.com/storage/properties/headers/demo.jpg"
}
404 Introuvable

L’établissement n’existe pas ou n’est pas public.

RecraHub utilise des cookies fonctionnels pour la connexion, la sécurité et les préférences linguistiques.