Ener.coop

Lstu API

POST https://ener.coop/a

Parameters:

• lsturl mandatory
  URL to shorten
• lsturl-custom optional
  Custom shortened text
• _format optional
  If equal to "json", response will be in JSON format, HTML format otherwise

Response:

• JSON: success
  {"url":"https:\/\/fiat-tux.fr","short":"https:\/ener.coop\/XzQBd6eFa","success":true}
• JSON: failure
  {"msg":"Failure reason","success":false}
• Response for HTML format
  You will be redirected to the Lstu classic interface with a message giving the shortened URL

GET https://ener.coop/shortened_url

Response:

• You will be redirected to the targeted URL or to the Lstu interface with a message giving the failure reason

GET https://ener.coop/shortened_url?_format=json

Response:

• JSON: success
  {"url":"https:\/\/fiat-tux.fr","success":true}
• JSON: failure
  {"msg":"Failure reason","success":false}

GET https://ener.coop/stats

It will use Lstu's cookies to know which shortened URL it will return statistics for.

If you are logged in as admin ("adminpwd" or "hashed_adminpwd" setting), it will give you statistics for all URLs, sorted by the most visited first, paginated with pages containing 10 records.

Parameters:

• page optional
  If you are logged in as admin, you can provide a "page" parameter
• _format optional
  If equal to "json", response will be in JSON format, HTML format otherwise

Response:

• Response for JSON format
  [{"short":"https:\/ener.coop\/shortened_url","url":"URL","counter":integer, how many unique visits of the shortened URL}]
• Response for HTML format
  A page with a table containing the same informations that the JSON response

GET https://ener.coop/stats/shortened_url

Get the details (visit counter, creation date, etc.) of a shortened URL.

Response:

• JSON: success
  {"url":"https:\/\/fiat-tux.fr","short":"https:\/ener.coop\/shortened_url","success":true,"counter":integer, how many unique visits of the shortened URL,"created_at":1519296674,"short":"URL","timestamp":1519296680}
• JSON: failure
  {"msg":"Failure reason","success":false}

POST https://ener.coop/stats

Parameters:

• adminpwd
optional
To do an admin login, set it to the password defined in the settings ("adminpwd" or "hashed_adminpwd")
• action
optional
To do an admin logout, set it to "logout".
• _format optional
  If equal to "json", response will be in JSON format, HTML format otherwise

Response:

• If "adminpwd" is defined:
  • JSON: success
    {"msg":"You have been successfully logged in.","success":true}
  • JSON: failure
    {"msg":"Bad password","success":false}
  • Response for HTML format
    You will have the statistics page with the admin stats if you're succesfully logged in, or your stats and a failure message otherwise
• If "action" is defined to "logout":
  Should always be successful
  • JSON: success
    {"msg":"You have been successfully logged out.","success":true}
  • Response for HTML format
    You will be redirected to Lstu statistics page

GET https://ener.coop/d/shortened_url

You must be logged in as admin ("adminpwd" or "hashed_adminpwd" setting) to use it.

Parameters:

• _format optional
  If equal to "json", response will be in JSON format, HTML format otherwise

Response:

• JSON: success
  {"url":"https:\/\/fiat-tux.fr","short":"https:\/ener.coop\/shortened_url","success":true}
• JSON: failure
  {"msg":"Failure reason","success":false}
• Response for HTML format
  You will be redirected to Lstu statistics page with a message in case of failure