Exilko / shaarli-api

Shaarli REST API

Installation

• Create mysql database shaarli-api
• Copy config.php.dist into config.php and setup your own settings.
• Run composer install (https://getcomposer.org/download/)
• Run: php cron.php

Requirements

• PHP 5.4.4
• MySQL
• PDO
• Apache RewriteEngine or Nginx

Update your installation

• Update your installation via Git (git update origin master) or the archive file.
• Check if there was any changes in config file, and add settings if necessary.
• Update external libraries with Composer. Run: composer update.
• Run cron the finalize the update: php cron.php.

Install via SSH exemple (debian)

cd /var/www
# Clone repo
git clone https://github.com/mknexen/shaarli-api.git
# Create mysql database
mysqladmin create shaarli-api -p
cd shaarli-api
# Copy `config.php.dist` into `config.php` and setup your own settings.
cp config.php.dist config.php
nano config.php
# Run composer install
composer install
# Run cron
php cron.php

Nginx configuration

location /shaarli-api {
    if (!-e $request_filename) {
       rewrite ^(/shaarli-api)/(.*)$ $1/index.php/$2;
    }
}

location /shaarli-api/database {
    deny all;
    return 403;
}

location /shaarli-api/class {
    deny all;
    return 403;
}

location ~ [^/]\.(php|html|htm)(/|$) {
    fastcgi_split_path_info ^(.+?\.php)(/.*)$;
    if (!-f $document_root$fastcgi_script_name) {
        return 404;
    }

    fastcgi_pass   unix:/var/run/php-fpm/php-fpm.sock;
    fastcgi_index  index.php;
    include        fastcgi.conf;
    fastcgi_param  PATH_INFO $fastcgi_path_info;
}

API Usage

• /feeds La liste des shaarlis
• /latest Les derniers billets
• /top Les liens les plus partagés
• /search Rechercher dans les billets
• /discussion Rechercher une discussion
• /syncfeeds Synchroniser la liste des shaarlis

Options

• &format=json
• &pretty=true

Samples

• Obtenir la liste des flux actifs: http://nexen.mkdir.fr/shaarli-api/feeds?pretty=1
• Obtenir la liste complète des flux: http://nexen.mkdir.fr/shaarli-api/feeds?full=1&pretty=1
• Obtenir les derniers billets http://nexen.mkdir.fr/shaarli-api/latest?pretty=1
• Obtenir le top des liens partagés depuis 48h: http://nexen.mkdir.fr/shaarli-api/top?interval=48h&pretty=1
• Faire une recherche sur php: http://nexen.mkdir.fr/shaarli-api/search?q=php&pretty=1
• Rechercher une discution sur un lien: http://nexen.mkdir.fr/shaarli-api/discussion?url=https://nexen.mkdir.fr/shaarli-river/index.php&pretty=1