Developer Hub
SupportDashboardGuides
  • Home
  • WiFi SDK
    • Overview
    • Integrating the SDK
      • iOS
        • QuickStart
        • SDK methods
          • initC4w
          • createCustomer
          • setupCustomer
          • createWPA2EnterpriseProfile
          • createPasspointProfile
          • getCreatedWPA2EnterpriseProfiles
          • getCreatedPasspointProfiles
          • getCustomerId
          • getCustomerInfo
          • updateCustomer
          • updateCustomerInfo
          • checkIfCustomerExists
          • getListOfPolicies
          • deletePasspointProfile
          • deleteWPA2EnterpriseProfile
          • setAPIAuthParams
          • setInterlinkedC4WIMobileSDKApplications
          • getInterlinkedC4WIMobileSDKApplications
          • logout
        • Objects
          • Customer
          • CustomerDocument
          • CustomerCreateResponse
          • CustomerInfo
          • CustomerQuery
          • WPA2EnterpriseProfile
          • PasspointProfile
        • Additional features
        • Changelog
      • Android
        • QuickStart
        • SDK methods
          • initC4w
          • createCustomer
          • setupCustomer
          • createWPA2EnterpriseProfile
          • deleteWPA2EnterpriseProfile
          • createPasspointProfile
          • deletePasspointProfile
          • isPasspointSupported
          • getCustomerId
          • getCustomerInfo
          • checkIfCustomerExists
          • updateCustomer
          • updateCustomerInfo
          • getListOfPolicies
          • setAPIAuthParams
          • getCreatedWPA2EnterpriseProfiles
          • getCreatedPasspointProfile
          • setInterlinkedC4WIMobileSDKApplications
          • getInterlinkedC4WIMobileSDKApplications
          • logout
        • Objects
          • Customer
          • CustomerDocument
          • CustomerCreateResponse
          • CustomerInfo
          • CustomerQuery
          • WPA2EnterpriseProfile
          • PasspointConfiguration
        • Additional features
        • Troubleshooting
        • Changelog
      • Flutter
        • QuickStart
        • Changelog
    • User experience
    • FAQ
  • Location SDK
    • Overview
    • Integrating the SDK
      • Android
        • Quickstart
        • Project initialization
        • SDK Methods
          • Enable/Disable
          • Handling blocking issues
          • Get Device Id
          • Reset device Id
          • Locations of Interest
            • Home location
            • Work location
        • Changelog
      • iOS
        • QuickStart
        • Installation
        • Project initialization
        • SDK methods
          • Initialization
          • Enable/Disable
          • Get Device Id
          • Reset device Id
          • Locations of interest
            • Home location
            • Work location
        • Reference versions
        • Changelog iOS
      • Flutter
        • QuickStart
        • Changelog
  • Demo toolkit
    • Demo app
    • Testlab WiFi setup
  • API Reference
    • Getting started
      • Authentication
      • Contacts
      • Locations
      • Geofences
      • Devices
      • Segments
      • WiFi logs
      • Events
    • Webhooks
    • Use cases
    • Legacy APIs (v2)
  • MyApps
    • My App Intro
    • Creating Apps
      • Access Journey Apps
      • Apps for the Dasbhoard
    • MyApps APIs and SDK
      • Access Journey SDK
      • REST APIs in MyApp
      • Context APIs
    • Sample projects
      • MyApps -Js SDK boilerplate
      • Video Advertising
      • Typeform integration
      • Facebook Pixel in Acces Journey
  • Tutorials
    • Sample onboarding flow for new app users
    • Integrating WiFi SDK in Flutter apps
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. API Reference
  2. Getting started

Devices

PreviousGeofencesNextSegments

Last updated 1 year ago

Was this helpful?

Devices include all pieces of HW deployed in your Locations.

To create a new Hotspot using the POST /v3/hotspots endpoint, you need to specify the MAC address of the access point and for some vendors also the Identifier.

The following table specifies for which vendor you need to provide the Identifier attribute. For these vendors, even if the Identifier is the same as the MAC address, it needs to be provided.

Vendor
Identifier

Aerohive Networks, Inc.

Aruba Networks

Required

Cambium Networks Limited

chillispot

Required

Cisco Systems

coovachilli

Required

Cradlepoint

dd-wrt

Required

endian

Required

Endian s.r.l.

Required

EnGenius

EnGenius CP ready

Extreme Networks

FortiNet

Hewlett Packard

Required

Huawei

ICC

Icomera Moovbox

Required

IgniteNet

LigoWave VAC

Meraki

Mojo Networks

Nomadix

Required

Open Mesh

Required

PowerCloud Systems

Required

Routerboard.com

Required

routeros

Required

Ruckus Wireless (Controller)

Ruckus Wireless (SCG)

Required

Ruckus Wireless (Standalone)

Required

Ruckus Wireless (Xclaim)

Required

Samsung

tanaza

tanaza_os

Teldat

Teltonika

Tiesse SpA

Ubiquiti Networks

Wilibox Deliberant Group LLC

Required

Wi-Next s.r.l.

Required

Xirrus Inc

Zebra Technologies Inc

Browan Communication Inc.

Required

List of access points of an organization

get

List hotspots for the organization Role: Organization Manager Scope: organization_read, hotspots_read

Authorizations
Path parameters
cidstringRequired

id of the organization (aka tenant)

Query parameters
creationDateStartstringOptional

Filter hotspots with date bigger than. Format YYYY-MM-DD

creationDateStopstringOptional

Filter hotspots with date lower than. Format YYYY-MM-DD

namestringOptional

Filter by name

macAddressstringOptional

Filter by hotspot macaddress

hotspotIdentifierstringOptional

Filter by hotspot identifier

venueIdstringOptional

Filter by venueId

deletedstringOptional

Filter by deleted properties. Default deleted=false

limitstringOptional
offsetstringOptional
Responses
200
Array with the hotspots
application/json
default
Error
application/json
get
GET //v3/hotspots/organizations/{cid} HTTP/1.1
Host: explore.cloud4wi.com
Authorization: Bearer JWT
Accept: */*
{
  "status": "text",
  "generated": "text",
  "count": 1,
  "hotspots": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "firmware": "text",
      "vendor": "text",
      "hotspotIdentifier": "text",
      "date": "text",
      "macAddress": "text",
      "venueId": "text",
      "country": "text",
      "city": "text",
      "address": "text",
      "latitude": 1,
      "longitude": 1,
      "deleted": true
    }
  ]
}

Get an Access Point

get

Get Access Point by Id Role: Organization Manager Scope: organization_read, hotspots_read

Authorizations
Path parameters
hotspotIdstringRequired

Hotspot id

Responses
200
Hotspot
application/json
default
Error
application/json
get
GET //v3/hotspots/{hotspotId} HTTP/1.1
Host: explore.cloud4wi.com
Authorization: Bearer JWT
Accept: */*
{
  "status": "text",
  "generated": "text",
  "hotspot": {
    "id": "text",
    "name": "text",
    "description": "text",
    "firmware": "text",
    "vendor": "text",
    "hotspotIdentifier": "text",
    "date": "text",
    "macAddress": "text",
    "venueId": "text",
    "country": "text",
    "city": "text",
    "address": "text",
    "latitude": 1,
    "longitude": 1,
    "deleted": true
  }
}

Get an Acess Point by hotspot identifier

get

Get an Access Point by hotspot identifier Role: Organization Manager Scope: organization_read, hotspots_read

Authorizations
Path parameters
hotspotIdentifierstringRequired

Hotspot identifier as configured in the dashboard

Responses
200
Hotspot
application/json
default
Error
application/json
get
GET //v3/hotspots/identifier/{hotspotIdentifier} HTTP/1.1
Host: explore.cloud4wi.com
Authorization: Bearer JWT
Accept: */*
{
  "status": "text",
  "generated": "text",
  "hotspot": {
    "id": "text",
    "name": "text",
    "description": "text",
    "firmware": "text",
    "vendor": "text",
    "hotspotIdentifier": "text",
    "date": "text",
    "macAddress": "text",
    "venueId": "text",
    "country": "text",
    "city": "text",
    "address": "text",
    "latitude": 1,
    "longitude": 1,
    "deleted": true
  }
}

Delete an hotspot

delete

Delete an hotspot Role: Organization Manager Scope: hotspots_write, organization_write

Authorizations
Path parameters
hotspotIdstringRequired

Hotspot id

Responses
200
Response
application/json
delete
DELETE //v3/hotspots/{hotspotId} HTTP/1.1
Host: explore.cloud4wi.com
Authorization: Bearer JWT
Accept: */*
200

Response

{
  "generated": "text",
  "status": "text"
}
  • GETList of access points of an organization
  • GETGet an Access Point
  • GETGet an Acess Point by hotspot identifier
  • POSTCreate a new hotspot
  • PUTUpdate an hotspot
  • DELETEDelete an hotspot

Create a new hotspot

post

Create a new hotspot
Note:
Depending on the routerType, the fields macAddress, hotspotIdentifier, and ssid may be required, optional, or not allowed. Please refer to the documentation for further information.
Role: Organization Manager Scope: hotspots_write, organization_write

Authorizations
Body
organizationIdstringOptional
venueIdstringOptional
namestringRequired
descriptionstringOptional
routerTypestring ยท enumRequiredPossible values:
macAddressstringRequired
hotspotIdentifierstringOptional

use according with routerType

ssidstringOptional

use according with routerType

addressAsLocationbooleanOptional

Use address, city, country, zip and state from location

countrystringOptional

country code as ISO 3166-1 alpha-2. Required if addressAsLocation is false

addressstringOptional

Required if addressAsLocation is false

citystringOptional

Required if addressAsLocation is false

statestringOptional

Required if addressAsLocation is false

zipstringOptional

Required if addressAsLocation is false

latitudenumberRequired
longitudenumberRequired
Responses
200
Response
application/json
post
POST //v3/hotspots HTTP/1.1
Host: explore.cloud4wi.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 305

{
  "organizationId": "text",
  "venueId": "text",
  "name": "text",
  "description": "text",
  "routerType": "Aerohive Networks, Inc.",
  "macAddress": "text",
  "hotspotIdentifier": "text",
  "ssid": "text",
  "addressAsLocation": true,
  "country": "text",
  "address": "text",
  "city": "text",
  "state": "text",
  "zip": "text",
  "latitude": 1,
  "longitude": 1
}
200

Response

{
  "generated": "text",
  "status": "text",
  "locationId": "text",
  "hotspotId": "text"
}

Update an hotspot

put

Update an hotspot.

Note: The properties venueId, routerType, macAddress, hotspotIdentifier, and ssid are not allowed.
Role: Organization Manager Scope: hotspots_write, organization_write

Authorizations
Path parameters
hotspotIdstringRequired

Hotspot id

Body
namestringOptional
descriptionstringOptional
countrystringOptional

country code as ISO 3166-1 alpha-2. Required if addressAsLocation is false

addressstringOptional

Required if addressAsLocation is false

citystringOptional

Required if addressAsLocation is false

statestringOptional

Required if addressAsLocation is false

zipstringOptional

Required if addressAsLocation is false

latitudenumberOptional
longitudenumberOptional
enabledbooleanOptional
Responses
200
Response
application/json
put
PUT //v3/hotspots/{hotspotId} HTTP/1.1
Host: explore.cloud4wi.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 154

{
  "name": "text",
  "description": "text",
  "country": "text",
  "address": "text",
  "city": "text",
  "state": "text",
  "zip": "text",
  "latitude": 1,
  "longitude": 1,
  "enabled": true
}
200

Response

{
  "generated": "text",
  "status": "text",
  "locationId": "text",
  "hotspotId": "text"
}