TYPO3 REST API

Version:1.2 Language:en Authors:SourceBroker Team Email:office@sourcebroker.dev Website:https://sourcebroker.dev/ License:This extension documentation is published under the CC BY-NC-SA 4.0 (Creative Commons) license Rendered:2021-10-06 21:21

The content of this document is related to TYPO3 CMS, a GNU/GPL CMS/Framework available from typo3.org .

This documentation is for the TYPO3 extension t3api.

If you find an error or something is missing, please: Report a Problem.

Table of Contents

• Getting started
  • What does it do
  • Installation
  • Configuration
    • TYPO3 8.7
    • TYPO3 9.5 / 10.4
  • Creating API resource
• Operations
  • Configuring operations
  • Supported operation methods
  • Response of GET collection operation
  • Item operation response
  • Customizing returned properties
  • Main endpoint
• Filtering
• Pagination
  • Global configuration
  • Resource specific configuration
• Security
• Serialization
• Integration
  • Integration with other extensions
  • News extension - Example integration
  • Inline output
• Customization
• Signals and slots
  • After deserialization
  • After processing operation
  • Customize serializer context attributes
  • Before grant access
• Multilanguage
• Handling File Upload
  • Creating file resource
  • Configuring TCA
  • File upload request
  • File upload response
  • Save reference to new file
  • Removing single file reference
  • Removing collection file reference
  • Customizing name of uploaded file
• Handling Cascade Persistence
  • Create relation to existing entity
  • Cascade persistence - creating related entity in single request
  • Cascade persistence - updating related entity in single request
• Use cases
  • Current user endpoint
  • Current user assignment
• Cross-Origin Resource Sharing (CORS)
• Miscellaneous
• Sitemap