API Usage - JointSpace API

WARNING

You must have the user and password from the pairing process to use the JointSpace API. See the Pairing section for more information.

To create an instance of the PhilTVApi class, you need to provide an object of type PhilTVApiParams as a parameter to the constructor.

If cacheStructure is set to true, the class will store the retrieved menu structure locally in a file using the unstorage library. On subsequent requests for the menu structure, it will check for an existing cached version before making a network call, which can greatly enhance performance by reducing unnecessary API requests. If caching is not required, you can simply omit the options parameter or set cacheStructure to false.

const apiClient = new PhilTVApi({
  apiUrl: 'https://192.168.0.22:1926/6',
  password: '5bewertrewref6968be556667552a49da5bf5fce3b379127cf74af2a3951026c2b',
  user: 'd1443b9fdeecd187277as5464564565e6315',
  options: {
    cacheStructure: true,
  },
});

Please see the all available methods in the API documentation