Api key auth (http_api_key)
Send an authentication token in the
Authentication-Token
header
to authenticate with the API.
This is the documentation for version 1.0
of the API. Last update on Jan 8, 2022.
https://api.spotipo.com
Send an authentication token in the
Authentication-Token
header
to authenticate with the API.
Before using the API you need yo get an API key by logging to Spotipo, and navigate to Account -> API Keys
Create and manage guest accounts
Allowed duration actual value
password
Data Limit type (1,'Total'),(2,'Daily'),(3,'Weekly'),(4,'Monthly') ( only if data_limit is True)
Upload speed , 0 for unlimited ( only if speed_limit is True)
Set speed to be unlimited for guestuser
Download speed , 0 for unlimited ( only if speed_limit is True)
Internal comments
Max devices allowed in this package
Set data to be unlimited for guestuser
Type for time duration (1,'Minutes'),(2,'Hours'),(3,'Days')
Data Limit ( only if data_limit is True)
username
curl \
-X POST https://api.spotipo.com/ext/{siteid}/api/v1/guestuser/ \
-H "Authentication-Token: $API_KEY" \
-d '{"duration_val":42,"password":"string","bytes_type":42,"speed_ul":42,"unlimited_speed":true,"speed_dl":42,"notes":"string","num_devices":42,"unlimited_data":true,"duration_type":42,"bytes_t":42,"username":"string"}'
{
"duration_val": 42,
"password": "string",
"bytes_type": 42,
"speed_ul": 42,
"unlimited_speed": true,
"speed_dl": 42,
"notes": "string",
"num_devices": 42,
"unlimited_data": true,
"duration_type": 42,
"bytes_t": 42,
"username": "string"
}
curl \
-X GET https://api.spotipo.com/ext/{siteid}/api/v1/guestuser/u/{username} \
-H "Authentication-Token: $API_KEY"
Note all the devices connected to this account will be disconnected
Allowed duration actual value
password
Data Limit type (1,'Total'),(2,'Daily'),(3,'Weekly'),(4,'Monthly') ( only if data_limit is True)
Upload speed , 0 for unlimited ( only if speed_limit is True)
Set speed to be unlimited for guestuser
Download speed , 0 for unlimited ( only if speed_limit is True)
Internal comments
Max devices allowed in this package
Set data to be unlimited for guestuser
Type for time duration (1,'Minutes'),(2,'Hours'),(3,'Days')
Data Limit ( only if data_limit is True)
username
curl \
-X PUT https://api.spotipo.com/ext/{siteid}/api/v1/guestuser/u/{username} \
-H "Authentication-Token: $API_KEY" \
-H "X-Fields: string" \
-d '{"duration_val":42,"password":"string","bytes_type":42,"speed_ul":42,"unlimited_speed":true,"speed_dl":42,"notes":"string","num_devices":42,"unlimited_data":true,"duration_type":42,"bytes_t":42,"username":"string"}'
# Headers
X-Fields: string
# Payload
{
"duration_val": 42,
"password": "string",
"bytes_type": 42,
"speed_ul": 42,
"unlimited_speed": true,
"speed_dl": 42,
"notes": "string",
"num_devices": 42,
"unlimited_data": true,
"duration_type": 42,
"bytes_t": 42,
"username": "string"
}
{
"name": {},
"duration_val": 42,
"email": "string",
"password": "string",
"bytes_type": 42,
"speed_ul": 42,
"unlimited_speed": true,
"auths": [
{
"id": 42,
"type": "string",
"data_used": "string",
"hostname": {},
"devicedata": {},
"online": {},
"last_seen_at": {},
"time_used": "string",
"mac": {}
}
],
"speed_dl": 42,
"id": 42,
"notes": "string",
"num_devices": 42,
"unlimited_data": true,
"duration_type": 42,
"bytes_t": 42,
"username": "string",
"status": {}
}
curl \
-X DELETE https://api.spotipo.com/ext/{siteid}/api/v1/guestuser/u/{username} \
-H "Authentication-Token: $API_KEY"
Create and manage Vouchers
Internal comments
Set data to be unlimited in voucher
Allowed duration actual value
Upload speed , 0 for unlimited ( only if speed_limit is True)
Set speed to be unlimited in voucher
Price in decimal
Number of vouchers to create
Download speed , 0 for unlimited ( only if speed_limit is True)
Optional Batch ID
Type for time duration (1,'Minutes'),(2,'Hours'),(3,'Days')
Total allowed data in MB, 0 for unlimited ( only if data_limit is True)
Max devices allowed in this package
curl \
-X POST https://api.spotipo.com/ext/{siteid}/api/v1/voucher/ \
-H "Authentication-Token: $API_KEY" \
-d '{"notes":"string","unlimited_data":true,"duration_val":42,"speed_ul":42,"unlimited_speed":true,"price":42.0,"num_to_create":42,"speed_dl":42,"batchid":42,"duration_type":42,"bytes_t":42,"num_devices":42}'
{
"notes": "string",
"unlimited_data": true,
"duration_val": 42,
"speed_ul": 42,
"unlimited_speed": true,
"price": 42.0,
"num_to_create": 42,
"speed_dl": 42,
"batchid": 42,
"duration_type": 42,
"bytes_t": 42,
"num_devices": 42
}
curl \
-X GET https://api.spotipo.com/ext/{siteid}/api/v1/voucher/{voucherid} \
-H "Authentication-Token: $API_KEY"
Internal comments
Set data to be unlimited in voucher
Allowed duration actual value
Upload speed , 0 for unlimited ( only if speed_limit is True)
Set speed to be unlimited in voucher
Price in decimal
Download speed , 0 for unlimited ( only if speed_limit is True)
Type for time duration (1,'Minutes'),(2,'Hours'),(3,'Days')
Total allowed data in MB, 0 for unlimited ( only if data_limit is True)
Max devices allowed in this package
curl \
-X PUT https://api.spotipo.com/ext/{siteid}/api/v1/voucher/{voucherid} \
-H "Authentication-Token: $API_KEY" \
-d '{"notes":"string","unlimited_data":true,"duration_val":42,"speed_ul":42,"unlimited_speed":true,"price":42.0,"speed_dl":42,"duration_type":42,"bytes_t":42,"num_devices":42}'
{
"notes": "string",
"unlimited_data": true,
"duration_val": 42,
"speed_ul": 42,
"unlimited_speed": true,
"price": 42.0,
"speed_dl": 42,
"duration_type": 42,
"bytes_t": 42,
"num_devices": 42
}
curl \
-X DELETE https://api.spotipo.com/ext/{siteid}/api/v1/voucher/{voucherid} \
-H "Authentication-Token: $API_KEY"
Get details about the guest data collected
curl \
-X GET https://api.spotipo.com/ext/{siteid}/api/v1/guest/ \
-H "Authentication-Token: $API_KEY"
{
"metadata": {
"page": 42,
"per_page": 42,
"total_count": 42,
"page_count": 42,
"links": []
},
"items": [
{
"id": 42,
"newsletter": true,
"phonenumber": "string",
"gender": "string",
"name": {},
"created_at": "2023-05-04T09:42:00+00:00",
"last_seen_at": "2023-05-04T09:42:00+00:00",
"guestsessions": [],
"dob": {},
"customfields": [
{
"fieldval": "string",
"id": 42,
"fieldname": "string"
}
],
"loginauths": [
{
"id": 42,
"type": "string",
"data_used": "string",
"hostname": {},
"devicedata": {},
"online": {},
"last_seen_at": {},
"time_used": "string",
"mac": {}
}
],
"consent": true,
"email": "string"
}
]
}
Get details about the payments collected from Guests.
Accepts the format ?page=1&per_page=10&search=&fromdate=&todate=
date should be DD-MM-YYYY format
curl \
-X GET https://api.spotipo.com/ext/{siteid}/api/v1/payments/accounts \
-H "Authentication-Token: $API_KEY"
{
"metadata": {
"page": 42,
"per_page": 42,
"total_count": 42,
"page_count": 42,
"links": []
},
"items": [
{
"id": 42,
"endtime": {},
"firstname": "string",
"status": {},
"auths": [
{
"id": 42,
"type": "string",
"data_used": "string",
"hostname": {},
"devicedata": {},
"online": {},
"last_seen_at": {},
"time_used": "string",
"mac": {}
}
],
"lastname": "string",
"phonenumber": "string",
"recurringpayments": [
{
"id": 42,
"next_payment_on": "2023-05-04T09:42:00+00:00",
"recurring_freq": "string",
"active": true,
"next_charge_currency": {},
"next_charge_amount": {},
"last_paid_on": "2023-05-04T09:42:00+00:00"
}
],
"transactions": [
{
"id": 42,
"starttime": {},
"endtime": {},
"status": {},
"comments": "string",
"amount": "string",
"email": "string",
"name": {},
"num_devices": 42
}
],
"email": "string",
"starttime": {}
}
]
}
Accepts the format ?page=1&per_page=10&search=&fromdate=&todate=date should be in DD-MM-YYYY format
curl \
-X GET https://api.spotipo.com/ext/{siteid}/api/v1/payments/transactions \
-H "Authentication-Token: $API_KEY"
{
"metadata": {
"page": 42,
"per_page": 42,
"total_count": 42,
"page_count": 42,
"links": []
},
"items": [
{
"id": 42,
"starttime": {},
"endtime": {},
"status": {},
"comments": "string",
"amount": "string",
"email": "string",
"name": {},
"num_devices": 42
}
]
}