@mattab opened this issue on March 25th 2008

Piwik provides a great API to request raw data. We now have to provide such an API to request the generated HTML out of piwik: - Provide an API to fetch piwik HTML

hideLogin()
hideSites()
hideLoggedUser()
setLanguage( $lg )

getBody() // returns <body>XXX</body>
getHead() // returns <head>XXX</head>
getJavascriptIncludes()
getCssIncludes()
  • make sure the CSS doesn't change the <body> so it doesnt change the app design
  • make sure piwik works when getting the pages in SSL https://
  • the generated URLs could use a prefix or different values in order to handle the existing application path.

    For example if the cms is at /dev/cms/ and piwik at /stats/piwik/ the piwik generated HTML should prefix all URL with /dev/cms/XYZ or /dev/cms/boot?mod=LoadApp&action=piwik

  • Provide an API to log a user in
login(username, password)
logout()
isUserConnected(username)
  • refs #5444 Plugins should have easy access to their own configuration file
  • refs #5588 make it easy for plugins to install piwik from outside
  • see also notes on phpmyvisites integration
@mattab commented on January 30th 2009

Piwik will be integrated directly in most CMS, blog. These third party softwares have often their own plugin installation process. So, we have to provide an API that can automatically install Piwik.

What does the Piwik install process? - Create some config files - Create databases - Create sites => already available with the API - Create users => already available with the API

I think we have to provide the API with 2 new functions :

createTables($tablePrefix, $databaseParameters)
createConfigFiles($listOfParameters)

Another solution is to merge these 2 functions in only one :

createTablesAndConfigFiles($tablePrefix, $listOfParameters)
@robocoder commented on December 28th 2009

See also kay's typo3 integration in comment:ticket:991:7

@mattab commented on March 29th 2010

Moving to post Piwik 1.0. It seems this is not a high requested feature, as Piwik got integrated with Typo3, simplescripts, softaculous, etc. without such API. I'd be interested to know how they deal with this?

We can always move it to 1.0 later if we get interesting requests.

@mattab commented on July 29th 2010

Several users are integrating Piwik successfuly using the various APIs: users, websites, fetch JS code, set/get user languages, etc. We will deal with any specific requests as they arrive.

This issue was closed on July 29th 2010
Powered by GitHub Issue Mirror