Skip to main content

FirstSpirit REST Service Alpha Builds

Stephan Windmüller
  • Updated

    The FirstSpirit REST Service is a web application providing a REST interface. Right now the module is in active development, giving access to several core functionalities. Crownpeak is asking customers to provide feedback on the existing endpoints and returned JSON data.

    Warning:
    • In its current state, the module should only be used for testing and development purposes.
    • This alpha release has not undergone security testing. Do not expose to public networks.
    • Do not use it on a production server.

     

    Installation

    1. Download the latest version (currently 0.0.21-beta) from the Artifactory.
    2. Place a file called fs-rest-service.properties in the lib directory of Tomcat (see Configuration).
    3. Install the module using ServerManager.
    4. A new web application /rest is created automatically. Select the correct web server and deploy the service.

     

    Configuration

    The file fs-rest-service.properties needs at least this configuration:

    fs.rest.host=localhost
fs.rest.port=1088
fs.rest.mode=SOCKET

    Change host name and port according to your local setup. The mode can be either SOCKET or HTTP.

    If the REST service is used as part of a web application, it may be required to configure the CORS origins:

    fs.rest.cors.allowedOriginPatterns=http://localhost:*

    Rate limiting can be configured as follows:

    fs.rest.rateLimit.enabled=true
fs.rest.rateLimit.requestsPerWindow=300
fs.rest.rateLimit.windowSeconds=60
fs.rest.rateLimit.warnThreshold=0.8

     

    Usage

    When the web application is deployed successfully, the base endpoint is available at /rest/v1/. The most simple query is /rest/v1/projects/.

    Please note that each request requires an Authorization header using Basic Auth.

    A list of all available endpoints is rendered using Swagger at /rest/swagger-ui/index.html.

     

    Feedback

    Do you have any questions about the usage? Does the result format not contain what you expected? Which endpoints do you miss?

    Please direct any feedback to the FirstSpirit Community.

     

    Changelog

    Version 0.0.1-alpha

    • First public version

    Version 0.0.2-alpha

    • Many new endpoints for creating content
    • Fixed an authentication issue in SaaS environment

    Version 0.0.3-alpha

    • Rename changes display name, not uid
    • Scripts can now be modified
    • Folder management
    • Access GOM and rules for link-templates
    • More DTO schema information in Swagger

    Version 0.0.4-alpha

    • Allow modification of most form element types
    • Deep-copy for page references
    • Fixed HTTP return codes

    Version 0.0.6-beta

    • Update Spring Boot to 4.0.6

    Version 0.0.7-beta

    • Fix form endpoint for CMS_LABEL, FS_BUTTON, CMS_COMMENT

    Version 0.0.12-beta

    • Add configurable rate limiting
    • Allow for compact editing of FS_REFERENCE
    • Upgrade Spring Boot to 4.1.0

    Version 0.0.16-beta

    • Simplify FS_REFERENCE handling
    • Increase default upload limit to 100 MB
    • Fix PATCH on empty CMS_INPUT_LINK
    • Add uid to LinkTemplateDTO
    • Replace PATCH /entity with dataset form editor API
    • Shortened URLs for handling datasets

    Version 0.0.21-beta

    • Return HTTP error 400 for invalid path parameters (e.g. UUIDs) instead of 500
    • Fixed HTTP error 500 for datasets with empty content
    • Entity DTOs now contain their location and multilingual display names
    • Updated Swagger-UI to 5.32.8

    Related articles

    Comments

    8 comments

    Date Votes

    Please sign in to leave a comment.