API reference

A frontend app enabled to consume REST API exposes a set of default endpoints.

Note

Every POST request can send the payload as x-www-form-urlencoded or application/json. For readability all examples will use Content-type: application/json.

• Authentication /auth
  • Obtain an access token
  • Renew the access token
  • Get the updated time to access token expiration
  • Revoking a refresh token
• Objects /objects
  • Get an object
  • Get a collection of objects
  • Create an object
  • Update an object
  • Create or update relations between objects
  • Replace relation data between objects
  • Add or edit children
  • Update child position
  • Delete an object
  • Delete a relation between objects
  • Remove a child from a parent
• Poster /poster
  • Get the image representation of object object_id as thumbnail url
• User profile /me
  • Obtain information about authenticated user

See also

To an index of all API requests see HTTP Routing Table