Wi Fi Management

Hotspotsystem

Learn how to use Hotspotsystem with Composio

Overview

SLUG: HOTSPOTSYSTEM

Description

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

Authentication Details

basic_encoded
stringRequired

Connecting to Hotspotsystem

Create an auth config

Use the dashboard to create an auth config for the Hotspotsystem toolkit. This allows you to connect multiple Hotspotsystem accounts to Composio for agents to use.

1

Select App

Navigate to Hotspotsystem.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Hotspotsystem Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4hotspotsystem_auth_config_id = "ac_YOUR_HOTSPOTSYSTEM_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000"  # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10    # Replace this with a method to retrieve an API key from the user.
11    # Or supply your own.
12    user_api_key = input("[!] Enter API key")
13
14    connection_request = composio.connected_accounts.initiate(
15        user_id=user_id,
16        auth_config_id=auth_config_id,
17        config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18    )
19
20    # API Key authentication is immediate - no redirect needed
21    print(f"Successfully connected Hotspotsystem for user {user_id}")
22    print(f"Connection status: {connection_request.status}")
23    
24    return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, hotspotsystem_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Hotspotsystem toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["HOTSPOTSYSTEM"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17    completion = openai.chat.completions.create(
18        model="gpt-4o",
19        messages=[
20            {
21                "role": "user",
22                "content": task,  # Your task here!
23            },
24        ],
25        tools=tools,
26    )
27
28    # Handle Result from tool call
29    result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30    print(f"[!] Completion: {completion}")
31    print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: List Customers

Description

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

Action Parameters

fields
string
limit
integer
offset
integer
sort
string

Action Response

data
objectRequired
error
string
request_id
string
status_code
integerRequired
successful
booleanRequired

Tool Name: List Customers by Location

Description

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

Action Parameters

fields
string
limit
integer
location_id
stringRequired
offset
integer
sort
string

Action Response

data
objectRequired
error
string
request_id
string
status_code
integerRequired
successful
booleanRequired

Tool Name: Generate Voucher (v1)

Description

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.

Action Parameters

format
stringDefaults to json
location_id
stringRequired
package
string
validity
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Locations

Description

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

Action Parameters

fields
string
limit
integer
offset
integer
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Misc Ping

Description

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

Action Parameters

echo
string
q
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Subscribers

Description

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

Action Parameters

fields
string
limit
integer
offset
integer
sort
string

Action Response

data
objectRequired
error
string
request_id
string
status_code
integerRequired
successful
booleanRequired

Tool Name: List Subscribers by Location

Description

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

Action Parameters

fields
string
limit
integer
location_id
stringRequired
offset
integer
sort
string

Action Response

data
objectRequired
error
string
request_id
string
status_code
integerRequired
successful
booleanRequired

Tool Name: List MAC Transactions

Description

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

Action Parameters

fields
string
limit
integer
offset
integer
sort
string

Action Response

data
objectRequired
error
string
request_id
string
status_code
integerRequired
successful
booleanRequired

Tool Name: List MAC Transactions by Location

Description

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.

Action Parameters

fields
string
limit
integer
location_id
stringRequired
offset
integer
sort
string

Action Response

data
objectRequired
error
string
request_id
string
status_code
integerRequired
successful
booleanRequired

Tool Name: List Paid Transactions by Location

Description

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.

Action Parameters

fields
string
limit
integer
location_id
stringRequired
offset
integer
sort
string

Action Response

data
objectRequired
error
string
request_id
string
status_code
integerRequired
successful
booleanRequired

Tool Name: List Social Transactions

Description

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

Action Parameters

fields
string
limit
integer
offset
integer
sort
string

Action Response

data
objectRequired
error
string
request_id
string
status_code
integerRequired
successful
booleanRequired

Tool Name: List Social Transactions by Location

Description

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.

Action Parameters

fields
string
limit
integer
location_id
stringRequired
offset
integer
sort
string

Action Response

data
objectRequired
error
string
request_id
string
status_code
integerRequired
successful
booleanRequired

Tool Name: List Voucher Transactions

Description

Tool to list voucher transactions globally across all locations.

Action Parameters

fields
string
limit
integer
offset
integer
sort
string

Action Response

data
objectRequired
error
string
request_id
string
status_code
integerRequired
successful
booleanRequired

Tool Name: List Voucher Transactions by Location

Description

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.

Action Parameters

fields
string
limit
integer
location_id
stringRequired
offset
integer
sort
string

Action Response

data
objectRequired
error
string
request_id
string
status_code
integerRequired
successful
booleanRequired

Tool Name: List Vouchers

Description

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

Action Parameters

fields
string
limit
integer
offset
integer
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Vouchers List by Location

Description

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

Action Parameters

fields
string
limit
integer
location_id
stringRequired
offset
integer
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired