- It works via Rest API call
- The flow will be the following :
- External captive portal will be configured on the controller
- When a user logs in on the portal, the login call will go to your backend
- Please configure the login url with the appropriate json body on your backend which will be called after the above step.
- Once the login url is hit, we will create an Access Request and send it to the external Radius server which will be also configured on the controller.
- On receiving the appropriate response – If Access Accept , we will start the user session with the details received in the access accept.
- Time based quota uses standard radius attribute
- For volume based, you will have to let us know VSA(Vendor specific attribute) in which you will send the volume quota details.
- Regular interims will be sent to your radius server via our controller . The time is configurable.
- Once the session is over or idle timeout hits, we will stop the user session and send accounting stop to your radius server.
Login url Details :
Post url : https://captivecloud.ray.life/ripple/smpLogin
Json body with the following keys :
- ssid – Copy the value from the redirected captive portal url and pass it as it is
- client_mac - Copy the value from the redirected captive portal url and pass it as it is
- ap_mac - Copy the value from the redirected captive portal url and pass it as it is
- unique_id - Copy the value from the redirected captive portal url and pass it as it is
- device_ip - Copy the value from the redirected captive portal url and pass it as it is
- request_username – This will be the shared username with us to make sure its called from authenticated sources. Both of us will configure the same value.
- request_password - This will be the shared password with us to make sure its called from authenticated sources. Both of us will configure the same value.
- client_username – This is the username that client would have inserted on the login page
- client_password - This is the password that client would have inserted on the login page
- In case its required to manually logout the user, please use the following :
Logout url Details :
Post url : https://captivecloud.ray.life/ripple/smpLogout
Json body with the following keys :
- ssid – Copy the value from the redirected captive portal url and pass it as it is
- client_mac - Copy the value from the redirected captive portal url and pass it as it is
- ap_mac - Copy the value from the redirected captive portal url and pass it as it is
- unique_id - Copy the value from the redirected captive portal url and pass it as it is
- device_ip - Copy the value from the redirected captive portal url and pass it as it is
- request_username – This will be the shared username with us to make sure its called from authenticated sources. Both of us will configure the same value.
- request_password - This will be the shared password with us to make sure its called from authenticated sources. Both of us will configure the same value.
- client_username – This is the username whose session is going on.