NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Hotspotsystem

hotspotsystem

HotspotSystem provides public Wi-Fi hotspot management and billing services for businesses.

Internet Of ThingsWeb del proveedor
Acciones
16
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (16)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

List CustomersHOTSPOTSYSTEM_CUSTOMERS_LISTAcción

Tool to list customers. Use when you need to retrieve customers with optional pagination, sorting, and field selection.

Parámetros de entrada

  • sortstring

    Sort by any field; prepend '-' for descending order.

  • limitinteger

    Limits number of returned objects; must be >= 1.

  • fieldsstring

    Comma-separated list of field names to include in the response.

  • offsetinteger

    Start index of returned range; must be >= 0.

Parámetros de salida

  • dataobjectObligatorio

    Raw JSON response from the API

  • errorstring

    Error if any occurred during the execution of the action

  • request_idstring

    Unique request identifier returned in response headers, if available

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

  • status_codeintegerObligatorio

    HTTP status code returned by the API

List Customers by LocationHOTSPOTSYSTEM_CUSTOMERS_LIST_BY_LOCATIONAcción

Tool to list customers by location. Use when you need to retrieve customers for a specific location with optional field selection, sorting, and pagination.

Parámetros de entrada

  • sortstring

    Property name to sort by; prepend '-' for descending order (e.g., '-registered_at')

  • limitinteger

    Number of items to return per page; must be >= 1

  • fieldsstring

    Comma-separated list of fields to include in the response (e.g., 'id,email,name')

  • offsetinteger

    Zero-based page index when paginating; must be >= 0

  • location_idstringObligatorio

    ID of the location

Parámetros de salida

  • dataobjectObligatorio

    Raw JSON response from the API

  • errorstring

    Error if any occurred during the execution of the action

  • request_idstring

    Unique request identifier returned in response headers, if available

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

  • status_codeintegerObligatorio

    HTTP status code returned by the API

Generate Voucher (v1)HOTSPOTSYSTEM_GENERATE_VOUCHER_V1Acción

Tool to generate an access voucher on the fly. Use when you need a single-use voucher for a specified location after ensuring sufficient credits.

Parámetros de entrada

  • formatstringenum

    Response format, either 'json' or 'xml'. Defaults to 'json'.

    jsonxml
  • packagestring

    Custom package ID defining voucher parameters. Defaults to the location's default free access if omitted.

  • validitystring

    Location ID or location group ID where the voucher can be activated. Defaults to the same location if omitted.

  • location_idstringObligatorio

    ID of the location from which voucher credits will be deducted.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List LocationsHOTSPOTSYSTEM_LOCATIONS_LISTAcción

Tool to list the resource owner's locations. Use when you need to retrieve locations with optional filtering, sorting, or pagination.

Parámetros de entrada

  • sortstring

    Property name to sort by; prepend '-' for descending order.

  • limitinteger

    Number of items to return per page; must be >= 1.

  • fieldsstring

    Comma-separated location property names to include in the response.

  • offsetinteger

    Zero-based page offset; must be >= 0.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Misc PingHOTSPOTSYSTEM_MISC_PINGAcción

Tool to perform health check against the HotspotSystem API. Use when verifying connectivity and availability.

Parámetros de entrada

  • qstring

    Additional optional query parameter for edge-case testing (unicode/special chars).

  • echostring

    Optional echo value sent as query parameter for testing; the API ignores it.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List SubscribersHOTSPOTSYSTEM_SUBSCRIBERS_LISTAcción

Tool to list newsletter subscribers. Use when you need to retrieve subscribers with optional field selection, sorting, and pagination.

Parámetros de entrada

  • sortstring

    Property name to sort by; prepend '-' for descending order (e.g., '-registered_at').

  • limitinteger

    Number of items to return per page; must be >= 1.

  • fieldsstring

    Comma-separated list of subscriber fields to include in the response (e.g., 'id,email,name').

  • offsetinteger

    Zero-based page index when paginating; must be >= 0.

Parámetros de salida

  • dataobjectObligatorio

    Raw JSON response from the API.

  • errorstring

    Error if any occurred during the execution of the action

  • request_idstring

    Unique request identifier returned in response headers, if available.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

  • status_codeintegerObligatorio

    HTTP status code returned by the API.

List Subscribers by LocationHOTSPOTSYSTEM_SUBSCRIBERS_LIST_BY_LOCATIONAcción

Tool to list subscribers by location. Use when you need to retrieve subscribers for a specific location with optional field selection, sorting, and pagination.

Parámetros de entrada

  • sortstring

    Property name to sort by; prepend '-' for descending order (e.g., '-registered_at')

  • limitinteger

    Number of items to return per page; must be >= 1

  • fieldsstring

    Comma-separated list of fields to include in the response (e.g., 'id,email,name')

  • offsetinteger

    Zero-based page index when paginating; must be >= 0

  • location_idstringObligatorio

    ID of the location

Parámetros de salida

  • dataobjectObligatorio

    Raw JSON response from the API

  • errorstring

    Error if any occurred during the execution of the action

  • request_idstring

    Unique request identifier returned in response headers, if available

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

  • status_codeintegerObligatorio

    HTTP status code returned by the API

List MAC TransactionsHOTSPOTSYSTEM_TRANSACTIONS_LIST_MACAcción

Tool to list MAC-based transactions. Use when you need to retrieve MAC transaction records with optional pagination and sorting.

Parámetros de entrada

  • sortstring

    Sort by any field; prepend '-' for descending order.

  • limitinteger

    Maximum number of items to return; must be >= 1.

  • fieldsstring

    Comma-separated list of field names to include in the response.

  • offsetinteger

    Zero-based offset for pagination; must be >= 0.

Parámetros de salida

  • dataobjectObligatorio

    Raw JSON response from the API

  • errorstring

    Error if any occurred during the execution of the action

  • request_idstring

    Unique request identifier returned in response headers, if available

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

  • status_codeintegerObligatorio

    HTTP status code returned by the API

List MAC Transactions by LocationHOTSPOTSYSTEM_TRANSACTIONS_LIST_MAC_BY_LOCATIONAcción

Tool to list MAC transactions by location. Use when you need to retrieve MAC transaction records for a specific location with optional pagination and sorting.

Parámetros de entrada

  • sortstring

    Sort by any field; prepend '-' for descending order

  • limitinteger

    Maximum number of items to return; must be >= 1

  • fieldsstring

    Comma-separated list of field names to include in the response

  • offsetinteger

    Zero-based offset for pagination; must be >= 0

  • location_idstringObligatorio

    ID of the location

Parámetros de salida

  • dataobjectObligatorio

    Raw JSON response from the API

  • errorstring

    Error if any occurred during the execution of the action

  • request_idstring

    Unique request identifier returned in response headers, if available

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

  • status_codeintegerObligatorio

    HTTP status code returned by the API

List Paid Transactions by LocationHOTSPOTSYSTEM_TRANSACTIONS_LIST_PAID_BY_LOCATIONAcción

Tool to list paid transactions by location. Use when you need to retrieve paid transaction records for a specific location with optional pagination and sorting.

Parámetros de entrada

  • sortstring

    Sort by any field; prepend '-' for descending order

  • limitinteger

    Maximum number of items to return; must be >= 1

  • fieldsstring

    Comma-separated list of field names to include in the response

  • offsetinteger

    Zero-based offset for pagination; must be >= 0

  • location_idstringObligatorio

    ID of the location

Parámetros de salida

  • dataobjectObligatorio

    Raw JSON response from the API

  • errorstring

    Error if any occurred during the execution of the action

  • request_idstring

    Unique request identifier returned in response headers, if available

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

  • status_codeintegerObligatorio

    HTTP status code returned by the API

List Social TransactionsHOTSPOTSYSTEM_TRANSACTIONS_LIST_SOCIALAcción

Tool to list social transactions. Use when you need to retrieve social transaction records with optional pagination and sorting.

Parámetros de entrada

  • sortstring

    Sort by any field; prepend '-' for descending order.

  • limitinteger

    Maximum number of items to return; must be >= 1.

  • fieldsstring

    Comma-separated list of field names to include in the response.

  • offsetinteger

    Zero-based offset for pagination; must be >= 0.

Parámetros de salida

  • dataobjectObligatorio

    Raw JSON response from the API

  • errorstring

    Error if any occurred during the execution of the action

  • request_idstring

    Unique request identifier returned in response headers, if available

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

  • status_codeintegerObligatorio

    HTTP status code returned by the API

List Social Transactions by LocationHOTSPOTSYSTEM_TRANSACTIONS_LIST_SOCIAL_BY_LOCATIONAcción

Tool to list social transactions by location. Use when you need to retrieve social transaction records for a specific location with optional pagination and sorting.

Parámetros de entrada

  • sortstring

    Sort by any field; prepend '-' for descending order

  • limitinteger

    Maximum number of items to return; must be >= 1

  • fieldsstring

    Comma-separated list of field names to include in the response

  • offsetinteger

    Zero-based offset for pagination; must be >= 0

  • location_idstringObligatorio

    ID of the location

Parámetros de salida

  • dataobjectObligatorio

    Raw JSON response from the API

  • errorstring

    Error if any occurred during the execution of the action

  • request_idstring

    Unique request identifier returned in response headers, if available

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

  • status_codeintegerObligatorio

    HTTP status code returned by the API

List Voucher TransactionsHOTSPOTSYSTEM_TRANSACTIONS_LIST_VOUCHERAcción

Tool to list voucher transactions globally across all locations.

Parámetros de entrada

  • sortstring

    Sort by any field; prepend '-' for descending order

  • limitinteger

    Maximum number of items to return; must be >= 1

  • fieldsstring

    Comma-separated list of field names to include in the response

  • offsetinteger

    Zero-based offset for pagination; must be >= 0

Parámetros de salida

  • dataobjectObligatorio

    Raw JSON response from the API

  • errorstring

    Error if any occurred during the execution of the action

  • request_idstring

    Unique request identifier returned in response headers, if available

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

  • status_codeintegerObligatorio

    HTTP status code returned by the API

List Voucher Transactions by LocationHOTSPOTSYSTEM_TRANSACTIONS_LIST_VOUCHER_BY_LOCATIONAcción

Tool to list voucher transactions by location. Use when you need to retrieve voucher transaction records for a specific location with optional pagination and sorting.

Parámetros de entrada

  • sortstring

    Sort by any field; prepend '-' for descending order

  • limitinteger

    Maximum number of items to return; must be >= 1

  • fieldsstring

    Comma-separated list of field names to include in the response

  • offsetinteger

    Zero-based offset for pagination; must be >= 0

  • location_idstringObligatorio

    ID of the location

Parámetros de salida

  • dataobjectObligatorio

    Raw JSON response from the API

  • errorstring

    Error if any occurred during the execution of the action

  • request_idstring

    Unique request identifier returned in response headers, if available

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

  • status_codeintegerObligatorio

    HTTP status code returned by the API

List VouchersHOTSPOTSYSTEM_VOUCHERS_LISTAcción

Tool to list the resource owner's vouchers across all locations. Use when you need to retrieve vouchers with optional filtering, sorting, or pagination.

Parámetros de entrada

  • sortstring

    Property name to sort by; prepend '-' for descending order.

  • limitinteger

    Number of items to return per page; must be >= 1.

  • fieldsstring

    Comma-separated voucher property names to return.

  • offsetinteger

    Zero-based page index when paginated by limit; must be >= 0.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Vouchers List by LocationHOTSPOTSYSTEM_VOUCHERS_LIST_BY_LOCATIONAcción

Tool to list vouchers by location. Use when you need to retrieve vouchers for a specific location with optional filtering and pagination.

Parámetros de entrada

  • sortstring

    Field to sort by; prepend '-' for descending.

  • limitinteger

    Number of items to return per page (minimum 1).

  • fieldsstring

    Comma-separated list of response fields to include.

  • offsetinteger

    Zero-based page index used with limit (minimum 0).

  • location_idstringObligatorio

    ID of the location.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not