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-api-files.md.
  • 🇬🇧 English

    • Structure of an API on Data Platform

    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.

    Here is the content of the source code of an API. Note that the SDK is available in NodeJS.

    ├── .gitignore
├── Dockerfile.dev
├── LICENSE.md
├── LICENSE.txt
├── app.js
├── dev.sh
├── forepaas
|   |-- cache-controller
|   |-- cache-redis
|   |-- cam
|   |-- logger-console
|   |-- qb
|   |-- reportings
|   |-- sdk
|   `-- webstorage
├── forepaas.json
├── package.json
├── run.sh
└── yarn.lock

    The core files of the API

    ├── app.js
├── forepaas.json
├── forepaas
├── package.json
└── yarn.lock
    • app.js: central point of the API and will serve to launch all the rest. Here you can directly access the ExpressJS instance (via the app variable)
    • forepaas.json: describes the list of extensions that make up your API
    • forepaas/: contains the extensions installed in your API
    • package.json : contains the NodeJS dependencies associated with your API
    • yarn.lock : we use yarn as package manager, it generates a file yarn.lock to lock dependencies associated with your API.

    Launcher utilities

    • Docker
      • Dockerfile.dev: a Docker description of the context in which the API runs.
      • dev.sh: a script to launch the docker environment quickly.
    • NodeJS
      • run.sh : a script to launch your API directly

    Git

    • .gitignore: defines the Git files and folder that will not be commited (in case you use git).

    License

    These two files mention the Data Platform license associated with this SDK.

    • LICENSE.md
    • LICENSE.txt

    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.