Structures d'accueil

Ces endpoints permettent de récupérer les structures d'accueil d'une organisation, pour faire la correspondance entre les structures ABCreche et celles de votre logiciel.

Les fiches personnel du pointage et les factures contiennent une propriété creche.uuid : utilisez-la pour retrouver la structure correspondante.

Les URIs ci-dessous sont relatives à https://abcreche.com/api/v1.

Authentification

Header	Valeur
Authorization	Bearer {token}
Accept	application/json

Le token doit appartenir à un utilisateur lié à l'organisation, sinon l'API répond 403.

Liste des structures d'accueil

Retourne les structures d'accueil de l'organisation auxquelles l'utilisateur du token a accès, triées par nom.

C'est exactement le même périmètre que l'API Factures : chaque facture retournée par l'API centralisée appartient à l'une de ces structures.

Request

• HTTP Method: GET
• URI: /organization/{organizationUuid}/creches

Exemple

GET /organization/5f963d99-0a8f-47e1-a04d-6c0d5b7b7d43/creches

Response

{
  "data": [
    {
      "uuid": "9928c211-abd9-4902-8db3-d3e8d2b89b0a",
      "name": "Crèche A",
      "street": "Rue de la Crèche",
      "street_number": "12",
      "city": "Bruxelles",
      "postal_code": "1000",
      "country_code": "BE",
      "phone": "+3221234567",
      "email": "[email protected]",
      "capacity": 24,
      "sector": "ONE",
      "sector_code": "ONE-BXL",
      "matricule_one": "123456789",
      "type": "creche",
      "type_label": "Crèche",
      "reference": "CRECHE-A"
    }
  ]
}

La liste n'est pas paginée.

Champs retournés

Property	Type	Description
uuid	UUID	Identifiant unique de la structure d'accueil dans ABCreche.
name	String	Nom de la structure d'accueil.
street	String/null	Rue de l'adresse.
street_number	String/null	Numéro de rue.
city	String/null	Ville.
postal_code	String/null	Code postal.
country_code	String/null	Code pays (ex. : BE).
phone	String/null	Numéro de téléphone de la structure.
email	String/null	Adresse email de la structure.
capacity	Integer/null	Capacité de la structure.
sector	String/null	Secteur de la structure.
sector_code	String/null	Code secteur.
matricule_one	String/null	Matricule ONE.
type	String	Code du type de structure : creche, nursery (accueillante), aes ou stage. Ce sont les valeurs acceptées par le filtre creche_types[] des factures.
type_label	String	Libellé du type : Crèche, Accueillante, AES ou Stage.
reference	String/null	Référence externe de la structure, définie par le gestionnaire dans les paramètres de la structure.

Attention

Cet endpoint ne donne pas accès aux données des enfants, des parents, ni aux paramètres de la structure.

Liste des structures pour le pointage

Variante utilisée par l'API de pointage du personnel. Elle retourne toutes les structures de l'organisation, même celles auxquelles l'utilisateur du token n'est pas rattaché, car l'API de pointage ne vérifie pas l'accès structure par structure.

Request

• HTTP Method: GET
• URI: /organization/{organizationUuid}/staff-time-clock/creches

Response

Mêmes champs que la liste ci-dessus, à deux différences près :

• type contient directement le libellé (Crèche, Accueillante, AES, Stage) ;
• country_code et type_label ne sont pas retournés.

{
  "data": [
    {
      "uuid": "9928c211-abd9-4902-8db3-d3e8d2b89b0a",
      "name": "Crèche A",
      "street": "Rue de la Crèche",
      "street_number": "12",
      "city": "Bruxelles",
      "postal_code": "1000",
      "phone": "+3221234567",
      "email": "[email protected]",
      "capacity": 24,
      "sector": "ONE",
      "sector_code": "ONE-BXL",
      "matricule_one": "123456789",
      "type": "Crèche",
      "reference": "CRECHE-A"
    }
  ]
}

Laquelle utiliser ?

• Intégration factures : utilisez /organization/{organizationUuid}/creches, qui correspond aux factures accessibles.
• Intégration pointage : utilisez /organization/{organizationUuid}/staff-time-clock/creches, qui correspond au personnel accessible via l'API de pointage.