README.md

   1 # pinboard4shaarli.cgi
   2
   3 The natural API for shaarli.
   4
   5 [![Build Status](https://travis-ci.org/mro/Shaarli-API-test.svg?branch=master)](https://travis-ci.org/mro/Shaarli-API-test)
   6
   7 ## Why?
   8
   9 The wish to have an API goes back to the [early days](https://sebsauvage.net/wiki/doku.php?id=php:shaarli:ideas).
  10
  11 And because shaarli started as a personal, minimal delicious clone, using a minimal subset of just
  12 the delicious API, seems natural to me. [pinboard](https://pinboard.in/api/) prooves the API
  13 is not only seasoned and mature, but also still up the job today.
  14
  15 Also I need a drop-in API compatibility layer for a wide range of shaarli versions out there being
  16 fed to by [ShaarliOS](https://code.mro.name/mro/ShaarliOS/).
  17
  18 ## How?
  19
  20 You find a single, statically linked, zero-dependencies ([Go](https://golang.org/)) binary which is both a
  21
  22 1. cgi to drop into your shaarli php webapplication next to index.php – as the API endpoint,
  23 2. commandline client to any shaarli out there, mostly for debugging purposes.
  24
  25 ![post flow](post.png)
  26
  27 ## Compatibility
  28
  29 All shaarlis from the old ages until at least spring 2019 (v0.10.3).
  30
  31 All systems [Go](https://golang.org/) can produce binaries for.
  32
  33 Just the delicious API calls in [openapi.yaml](openapi.yaml)
  34
  35 The API server code (delicious implementation) is the same as in [ShaarliGo](https://code.mro.name/mro/ShaarliGo).
  36
  37 ## Design Goals
  38
  39 | Quality         | very good | good | normal | irrelevant |
  40 |-----------------|:---------:|:----:|:------:|:----------:|
  41 | Functionality   |           |      |    ×   |            |
  42 | Reliability     |     ×     |      |        |            |
  43 | Usability       |           |   ×  |        |            |
  44 | Efficiency      |           |      |    ×   |            |
  45 | Changeability   |           |   ×  |        |            |
  46 | Portability     |     ×     |      |        |            |
  47