For AI agents: the complete documentation index is available at https://docs.dataplatform.ovh.net/llms.txt, the full documentation bundle is available at https://docs.dataplatform.ovh.net/llms-full.txt, and this page is available as Markdown at https://docs.dataplatform.ovh.net/sdk/api.md.
  • 🇬🇧 English

    • Front API SDK

    Warning

    Rework pending, no delivery date. The Front App SDK (ReactJS) and the Front API SDK (NodeJS) are both being replaced. This page documents the current release, remains accurate, and is maintained until the replacement ships. Code written against it keeps working.

    In Data Platform, the Front API is the Project's gateway for remote requests. It is built and deployed using API Manager and has two main purposes:

    • Access from the Front App with all tight integration built-in
    • Access from other remote systems that need to request your Project

    In addition, vanilla Front APIs deployed by default have the following features:

    Customize your Project's API using the SDK

    When is customization needed?

    The aforementioned features are sufficient for most use cases, but you can extend it much further. The Front API SDK is written in NodeJS. After an API has been deployed, it is easy to download it and start hacking.

    Typical cases:

    • needs to provide an endpoint with a specific request and response format
    • needs to implement transformers to dynamically change QB requests (adding fields, changing filters or scales on the fly)
    • implement advanced permissions restrictions on data fields
    • merge several QB requests to one result
    • request external API on behalf of Front App
    • ... and whatever you may do in NodeJS!
    Warning

    Customizing a Front API requires some knowledge of JavaScript, NodeJS and Web Service development, and should be done by advanced users.

    Requirements

    • NodeJS: Front API is implemented in NodeJS
    • Docker: Front API may be started with Docker
    • Git: we strongly advise to version your code with Git and use it to deploy on Data Platform

    What can you customize?

    Check out the following articles to discover how to customize an API using the SDK.

    Go further

    If you need training or technical assistance to implement our solutions, contact your sales representative or click on this link to get a quote and ask our Professional Services experts for a custom analysis of your project.

    Ask questions, give your feedback and interact directly with the team building the Data Platform on the dedicated Discord channel.

    If you need support with your OVHcloud services, create a request in our Help Centre.

    Join our community of users.