.. include:: ../Includes.txt .. _configuration: ============= Configuration ============= To configurate this extension, you have to add the static template of Newt After adding the static, you will find the constants in the Constant editor: ===================================== ========== =================================================================== ======================================= Property: Data type: Description: Default: ===================================== ========== =================================================================== ======================================= settings.apiName string Name of this API, this will be sent to the client, the user is able to change it (optional) ------------------------------------- ---------- ------------------------------------------------------------------- --------------------------------------- settings.apiPageId int Page ID to use for url-build the API-Link Point to the page you like to use as API Because the Extension uses a typNum, it will work with any page This is just to have a nice URL... ------------------------------------- ---------- ------------------------------------------------------------------- --------------------------------------- settings.apiTypeNum string Page TypeNum for the API 1201 ------------------------------------- ---------- ------------------------------------------------------------------- --------------------------------------- settings.apiBaseUrl string Base-URL in case you use "/" in site-configuration For the API to work, it is important to have a full-URL When creating URL's with the site-configuration, this is sometimes hard to get working, in case you use "/" as base-url, place the sites Host here (e.g.: https://example.com) ------------------------------------- ---------- ------------------------------------------------------------------- --------------------------------------- settings.tokenExpiration int Token expiration in seconds (0 = infinit) Insert here the lifetime of the token in seconds ------------------------------------- ---------- ------------------------------------------------------------------- --------------------------------------- settings.fileStorageId int FileStorage to use for Image-Uploade Fallback to the default-storage ------------------------------------- ---------- ------------------------------------------------------------------- --------------------------------------- settings.feuserNamePrefix string Loginname prefix for FE-Users * This will be used to differate between backend-user and fe-users ------------------------------------- ---------- ------------------------------------------------------------------- --------------------------------------- settings.serverTopic string Server-Topic, normaly this will be the host of your API-Server You will get this by login into newt.infonique.ch ------------------------------------- ---------- ------------------------------------------------------------------- --------------------------------------- settings.serverSecret string Server-Secret is used to verify API-Calls to newt.infonique.ch You will get this by login into newt.infonique.ch ------------------------------------- ---------- ------------------------------------------------------------------- --------------------------------------- persistence.storagePid integer Default storage PID Defines the placement of the endpoint-configurations ===================================== ========== =================================================================== ======================================= [tsref:plugin.tx_newt] ===================================== ========== =================================================================== ======================================= Property: Data type: Description: Default: ===================================== ========== =================================================================== ======================================= view.templateRootPath string Defines the path where the admin-template are located EXT:newt/Resources/Backend/Templates/ ------------------------------------- ---------- ------------------------------------------------------------------- --------------------------------------- view.partialRootPath string Defines the path where the admin-partials are located EXT:newt/Resources/Backend/Partials/ ------------------------------------- ---------- ------------------------------------------------------------------- --------------------------------------- view.layoutRootPath string Defines the path where the admin-layout are located EXT:newt/Resources/Backend/Layouts/ ===================================== ========== =================================================================== ======================================= [tsref:plugin.tx_newt_admin] Routing example =============== .. code-block:: yaml routeEnhancers: NewtServerconfigPlugin: type: Extbase extension: Newt plugin: Serverconfig routes: - routePath: /newt-serverconfig _controller: 'Endpoint::index' - routePath: /newt-token-refresh _controller: 'Endpoint::tokenRefresh' NewtApiPlugin: type: Extbase extension: Newt plugin: Api routes: - routePath: /endpoints _controller: 'Api::endpoints' - routePath: /create/{endpointUid} _controller: 'Api::create' _arguments: endpointUid: uid - routePath: /read/{endpointUid} _controller: 'Api::read' _arguments: endpointUid: uid - routePath: /update/{endpointUid} _controller: 'Api::update' _arguments: endpointUid: uid - routePath: /delete/{endpointUid} _controller: 'Api::delete' _arguments: endpointUid: uid - routePath: /list/{endpointUid} _controller: 'Api::list' _arguments: endpointUid: uid defaultController: 'Api::endpoints' PageTypeSuffix: type: PageType default: '' map: data.json: 1201 .. toctree:: :maxdepth: 5 :titlesonly: AddEndpoints/Index