BEdita documentation

BEdita frontend app can be easily enabled to serve REST API. Once enabled the API present a set of default endpoints that can be customized for frontend needs.

REST API

• Setup a frontend to consume API
  • Enable API on new frontend app
  • Enable API on old frontend app
• Configuration
• Response and Errors
  • Response
  • Errors
    • Error codes
• Authentication
  • Architecture
  • Customize authentication
• Pagination
  • Define your API pagination default options
  • Paginate objects in custom endpoints
• Uploading files
  • Limiting which mime types are allowed
  • Limiting max file size allowed and quota available
  • Creating a custom object type supporting upload
• Customize endpoints
  • Custom endpoints
  • Blacklist endpoints
  • Enable special object types endpoints
  • Setup query string parameters
    • Configure allowed query string parameter in ApiController
    • Configure allowed query string parameter in configuration file
    • Add allowed query string parameters on the fly
  • Customize /objects endpoint
    • Configure your own URL path filter types
    • Configure query string paramters to filter objects
• Formatting BEdita objects
  • Introducing the ApiFormatter Component
  • Help ApiFormatter to cast object fields in the right way
  • Remove unwanted fields
    • Add fields to remove from configuration
    • Add fields to remove on the fly
  • Keep fields that are removed by default
    • Add fields to keep from configuration
    • Add fields to keep on the fly
• API reference
  • 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
      • Get object’s children
      • Get object’s children of type section
      • Get object’s children of type contents
      • Get object’s descendants
      • Get object’s siblings
      • Get relations count
      • Get the related objects detail
      • Get the relation detail between objects
      • Get the child position
    • 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
  • Files upload /files
    • Upload a file
  • Posters /posters
    • Get the image representation of object object_id as thumbnail url
    • Get a collection of image representations
  • User profile /me
    • Obtain information about authenticated user
• Glossary

Indices and tables

• Index
• HTTP Routing Table