URL scheme

Every API calls are done on an URL like:
https://api.skriv.com/VERSION/OBJECT/METHOD/PARAMETERS

With:

  • VERSION being the API version number (with a "v" prefix)
  • OBJECT being the name of the distant object
  • METHOD being the name of the called method
  • PARAMETERS being the possible parameters given on the URL

Examples:

  • https://api.skriv.com/v1/user/get
  • https://api.skriv.com/v1/project/get/145/23

API version

The API version number is currently 1.
This number will change in case of changes that break backward-compatibility.

Backward-compatibility breaking changes:

  • If the same input on a method will produce a different output.
  • If some data are removed from the JSON response of a method.
  • If objects or methods are removed.

Not considered as backward-compatibility breaking changes:

  • If a bug fix induces that the same input on a method produces a different output.
  • If some data are added to the JSON response of a method, without changing anything to the former data.
  • If new objects or methods are added to the API.