Meraki Captive Portal API

Logic Flow

  1. The client connects to AP.
  2. AP redirects the client to splash server.
  3. Splash page displays content and includes additional parameters in the URL.
  4. The client interacts with the site (form, oAuth, SMS, etc.).
  5. Form submission redirects the client to the base_grant_url.
  6. Meraki grants the login and redirects the client to the continue_url.
  7. The client is logged in and lands on their intended (or modified) site.

HTTP Logic

Splash Page URL

This is the initial URL the client will be redirected to once associated with the network, which was set in the Custom Splash URL section in the Meraki Dashboard.

Sample URL

[GET]

https://splashserver/splash

Meraki will automatically append additional parameters to be parsed by the client.

https://splashserver/splash?base_grant_url=https%3A%2F%2Fn143.network-auth.com%2Fsplash%2Fgrant&user_continue_url=http%3A%2F%2Fmeraki.com%2F&node_id=1301936&node_mac=00:18:0a:13:dd:b0&gateway_id=1301936&client_ip=10.162.50.40&client_mac=ff:ff:96:d5:d5

Parameters

Name Sample Data Comments
base_grant_url https://n143.network-auth.com The URL a client will use to authenticate
user_continue_url http://meraki.com The URL the client intended on visiting
node_id 1301936 not used
node_mac 00:18:0a:13:dd:b0 Access Point’s physical network address
gateway_id 1301936 not used
client_ip 10.162.50.40 Client’s logical network address
client_mac ff:ff:96:d5:d5 Client’s physical network address

Login URL

The login simply requires you to redirect the client browser through a [GET] request to the base_grant_url. You can optionally add a continue_url and a duration query to tailor the login process. To send the client onto their intended site, copy the user_continue_url value into the continue_url parameter.

The simplest implementation is to assign a button or hyperlink which directs the browser to the base_grant_url.

Sample URL

[GET]

https://n143.network-auth.com/splash/grant/?continue_url=http://ask.co.uk/&duration=3600

Parameters

Optional parameters that can be sent with the [GET] request to set the duration and final landing page.

These parameters must be sent in the URL query string (i.e ?continue_url=http://meraki.com/&**duration**=3600).

Name Sample Data Comments
continue_url http://meraki.com The URL a client will be redirected to after login
duration 3600 Sets the number of seconds for authorization. Max = 2592000

Sample Code

Click-through Examples

Next