Externe integraties

Kernplatform
integrations_readExterne integratiesApparaatbeheer

De External Integrations die een faciliteit gebruikt. partner_configs omvat elke partnerintegratie (lidmaatschaps- en boekingssystemen, betalingen, de netwerkcontroller, alarmopvolging, doorsturen van CRM-leads en andere): of de integratie is ingeschakeld en de instellingen ervan, waarbij geheimen alleen als ingesteld of niet ingesteld worden getoond. facility_config omvat instellingen die op de faciliteit zelf staan: alarmrelais, vermeldingen in gidsen en chatkanalen. test_network_controller controleert of een apparaat ter plaatse kan inloggen bij de netwerkcontroller van de faciliteit. Geef facilityIds mee om meerdere faciliteiten te controleren.

Acties:

  • partner_configs: Partnerintegraties. Partners die beschikbaar zijn voor de faciliteit, ingeschakeld of niet.
  • facility_config: Integratie-instellingen van de faciliteit.
  • test_network_controller: De netwerkcontroller testen. Vraagt een online, bij voorkeur bekabeld, Performance Hub-apparaat bij de faciliteit in te loggen bij de netwerkcontroller die in External Integrations is ingesteld. Geeft een time-out als het adres van de controller onjuist is of op een ander netwerk ligt.

Parameters

NaamTypeBeschrijving
action*"partner_configs" | "facility_config" | "test_network_controller"Wat er moet gebeuren; elke actie wordt beschreven in de toolbeschrijving.
facilityIdstringFaciliteit-ID. Optioneel als de verbonden faciliteit de faciliteit is die je bedoelt.
facilityIdsarrayMeerdere faciliteit-ID's, om hetzelfde verzoek bij elk ervan uit te voeren. Gebruik dit in plaats van facilityId.
partnerIdstringAlleen deze partner-ID (partner_configs)
partnerNamestringNaam of code van de partner bevat dit (partner_configs)
enabledOnlybooleanAlleen ingeschakelde integraties (partner_configs)
timeoutMsintegerHoe lang op het apparaat wordt gewacht, in milliseconden (standaard 10000) (test_network_controller)