TVCast Partner API

Appearance

Facilities ​

Les routes facilities permettent de consulter et mettre a jour les informations d'un etablissement accessible au partenaire.

Recuperer une facility ​

Retourne les informations generales d'un etablissement accessible au partenaire.

http
GET /v1/facilities/{facilityExternalId}/

Champs typiques ​

La reponse peut contenir notamment:

  • id
  • id_external
  • status
  • name
  • date_created
  • date_updated
  • ssid_public
  • address
  • subscription_url
  • type
  • subscribed
  • devices
  • le nombre d'areas
  • le nombre d'entrees dans areas_autocomplete_list

Les champs effectivement visibles dependent des permissions CMS du partenaire.

Exemple ​

bash
curl \
  -H "Authorization: Bearer <partner-token>" \
  https://partner.api.tvcast.fr/v1/facilities/facility-001/

Recuperer les areas ​

Retourne les chambres, zones ou espaces rattaches a l'etablissement.

http
GET /v1/facilities/{facilityExternalId}/areas

Comportement ​

  • Les id_external des areas sont retournes au format complet {facilityExternalId}-{areaExternalId}.
  • Les champs data_services et data_general sont normalises en tableaux vides s'ils sont absents.
  • Les dates data_services[].end peuvent etre normalisees au format ISO string.

Exemple ​

bash
curl \
  -H "Authorization: Bearer <partner-token>" \
  https://partner.api.tvcast.fr/v1/facilities/facility-001/areas

Liste des chambres pour provisionnement ​

areas_autocomplete_list represente la liste des chambres connues pour une facility partenaire.

Cette liste sert a faciliter le provisionnement des equipements en chambre. Elle permet typiquement a une interface ou a un outil d'installation de proposer les chambres disponibles au moment de l'association d'un equipement.

Cette ressource est distincte de GET /facilities/{facilityExternalId}/areas, qui retourne les areas avec davantage de donnees metier. areas_autocomplete_list est optimisee pour le provisionnement, pas pour la consultation detaillee.

Recuperer la liste ​

Retourne la liste des chambres proposees aux outils de provisionnement.

http
GET /v1/facilities/{facilityExternalId}/areas_autocomplete_list

Exemple de reponse indicative ​

json
{
  "areas_autocomplete_list": [
    { "id_external": "facility-001-101", "name": "Chambre 101" },
    { "id_external": "facility-001-102", "name": "Chambre 102" }
  ]
}

Mettre a jour la liste ​

Met a jour la liste des chambres utilisee par les outils d'installation ou de provisionnement.

http
PATCH /v1/facilities/{facilityExternalId}/areas_autocomplete_list

Corps attendu:

json
{
  "value": [
    { "id_external": "101", "name": "Chambre 101" },
    { "id_external": "102", "name": "Chambre 102" }
  ]
}

Exemple:

bash
curl -X PATCH \
  -H "Authorization: Bearer <partner-token>" \
  -H "Content-Type: application/json" \
  -d '{"value":[{"id_external":"101","name":"Chambre 101"},{"id_external":"102","name":"Chambre 102"}]}' \
  https://partner.api.tvcast.fr/v1/facilities/facility-001/areas_autocomplete_list

Mettre a jour une propriete ​

Les mises a jour historiques attendent un corps contenant value.

La reponse contient generalement uniquement la propriete modifiee.

http
PATCH /v1/facilities/{facilityExternalId}/name
PATCH /v1/facilities/{facilityExternalId}/ssid_public
PATCH /v1/facilities/{facilityExternalId}/subscription_url

Mettre a jour le nom ​

Modifie le nom affiche de l'etablissement.

http
PATCH /v1/facilities/{facilityExternalId}/name

Corps attendu:

json
{
  "value": "Nom de l'etablissement"
}

Reponse indicative:

json
{
  "name": "Nom de l'etablissement"
}

Exemple:

bash
curl -X PATCH \
  -H "Authorization: Bearer <partner-token>" \
  -H "Content-Type: application/json" \
  -d '{"value":"Nouveau nom"}' \
  https://partner.api.tvcast.fr/v1/facilities/facility-001/name

Mettre a jour le SSID public ​

Modifie le SSID public associe a l'etablissement.

http
PATCH /v1/facilities/{facilityExternalId}/ssid_public

Corps attendu:

json
{
  "value": "Wifi Public"
}

Reponse indicative:

json
{
  "ssid_public": "Wifi Public"
}

Cette valeur peut avoir un impact operationnel selon les equipements et les processus de provisionnement en place.

Mettre a jour l'URL de souscription ​

Modifie l'URL de souscription ou de portail associee a l'etablissement.

http
PATCH /v1/facilities/{facilityExternalId}/subscription_url

Corps attendu:

json
{
  "value": "https://example.com/subscribe"
}

Reponse indicative:

json
{
  "subscription_url": "https://example.com/subscribe"
}

Notes communes ​

  • Toutes les routes v1 exigent Authorization: Bearer <cms-partner-token>.
  • Les permissions CMS limitent les facilities et champs accessibles.
  • Une reponse 403 peut etre retournee meme avec un token valide si la facility ou le champ n'est pas autorise pour le partenaire.
  • Les routes PATCH conservent le format legacy avec une cle value.