Icon

    Each extension consists of client-side and server-side part. Client-side means resources, which are living inside client's browser, e.g. HTML, Javascript, CSS, images etc.

    Server-side part, API endpoints, are executed on the server and can be called from the outside using HTTP request. 

    When to create API endpoint

    There are several situations, where you need a specific endpoint for your application:

    • Custom business logic is required
    • Calling 3rd party systems is necessary
    • Client API does not offer desired functions

    Specification

    An API Endpoint is Groovy/Java class compiled and executed on the server at runtime. It may use 3rd party JAR libraries provided as JAR resource inside the extension.

    On the source code level, it's possible to use variety of classes and methods, including access to basic BellaDati objects and data - Data sets, Reports, Machine Learning.

    API Endpoint is exposed to the outter world using HTTP server and is accepting HTTP GET, POST, DELETE and PUT requests.

    Endpoint URL
    http://belladati_host/extension/detail:endpoint/EXT_ID/ENDPOINT_NAME
    http://belladati_host/ext/detail?id=EXT_ID&action=ENDPOINT_NAME


    Structure

    API Endpoint a class written is Groovy/Java and overriding doGet(), doPost(), doPut() and doDelete() methods. 

    Types whitelist

    Beside types and packages below, all types and packages from provided JAR library are on white list too.

    Package name
    java.util
    java.util.regex
    org.apache.commons.logging
    com.belladati.json
    • No labels