1. Documentation

1.1. Blocks Spreadsheet

Construction de la Spreadsheet

  1. Publier la Spreadsheet

Dans le menu Fichier, choisir Publier sur le Web…​

Cliquer sur Publier

INFO: L’url proposée n’est pas celle à utiliser dans la configuration du Block Spreadsheet.

  1. Format de la Spreadsheet

La Spreadsheet doit respecter les éléments suivants :

  • La 1ère ligne contient les noms des champs à utiliser.

  • La 2ème ligne contient le type des colonnes (string par défaut, si ça n’est pas renseigné).

  • La 3ème ligne contient des paramètres spécifiques (dependsOn ou parameter).

  • Les données commencent à la 4ème ligne.

1.2. API BlockProvider - /blockconfigs

request
GET /blockconfigs?show_no_revision=true&blocks=BLOCK_NAME&excludes=ASSET_TO_EXCLUDE%3Acss HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/vnd.of.cms-block-provider.v2.0+json;charset=UTF-8
Host: localhost:8080
Parameter Default Description

show_no_revision

false

Filtre sur les configurations versionnées

blocks

null

Filtre sur le nom des Blocks avec un pattern

name

null

Filtre sur le nom exact d’un Blocks

includes

null

Permet d’inclure seulement les blocks demandés (par nom)

excludes

null

Permet d’exclure certain asset de la réponse (au format name ou name:type)

1.2.1. BlockConfig - spécification de la configuration d’un Block

Le BlockConfig permet de spécifier au CMS les Blocks à exposer au niveau du PageBuilder.

response
[ {
  "name" : "BLOCK_NAME",
  "type" : "Display",
  "configurations" : [ {
    "version" : "2.0.0",
    "templates" : [ {
      "name" : "TEMPLATE_NAME",
      "engine" : "mustache",
      "source" : "TEMPLATE_SOURCE",
      "assets" : {
        "js" : [ "ASSET_JS_URL.js" ],
        "css" : [ "ASSET_CSS_URL.css" ]
      }
    } ]
  } ]
} ]

1.2.2. Résumé du format

Path Type Description

[].name

String

Identifiant fonctionnel unique au sein du CMS.

[].type

String

Enumération définissant le type de Block.

[].configurations

Array

Configurations disponibles du Block

[].configurations[].version

String

Version des données de configuration.

[].configurations[].templates[]

Array

Définit le template du Block.

[].configurations[].templates[].name

String

Définit le nom du template.

[].configurations[].templates[].source

String

Le template du Block.

[].configurations[].templates[].engine

String

Le moteur à utilisé pour le rendu du template.

[].configurations[].templates[].assets

Object

Les contenus statiques à utiliser pour rendre le Block.

[].configurations[].templates[].assets.js[]

Array

L’url absolue où récupérer les scripts JS à utiliser.

[].configurations[].templates[].assets.css[]

Array

L’url absolue où récupérer les feuilles de style CSS à utiliser.

1.3. API Asset - /assets

request
GET /assets?page=0&size=1&sort=version&order=desc HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/vnd.of.cms-block-provider.v2.0+json;charset=UTF-8
Host: localhost:8080
Parameter Default Description

page

0

Numéro de la pagination à renvoyer.

size

50

Nombre d’asset à renvoyer.

sort

version

Nom du champs sur lequel trier.

order

desc

Sens du tri de la liste : asc/desc.

1.3.1. Asset - spécification d’un asset html

response
[ {
  "id" : "f5b05028-9e74-43b7-826f-f0be35618391",
  "name" : "NAME",
  "url" : "URL",
  "source" : "SOURCE",
  "type" : "css",
  "version" : 2,
  "storageId" : null
} ]

1.3.2. Résumé du format

Path Type Description

[].id

String

Identifiant unique de l’asset au format UUID.

[].name

String

Un identifiant textuel plus simple à trouver l’asset.

[].url

String

L’URL servant à accéder à la source de l’asset.

[].type

String

Le type de l’assets, css/js/fonts/images.

[].version

Number

Le numéro de version de l’asset.

[].source

String

Le code source de l’asset.

[].storageId

Null

L’identifiant de stockage de l’asset (uniquement pour les images).

2. Swagger documentation

Blocktopus dispose d’un écran de test de l’API ici

3. Changelog

Unresolved directive in index.adoc - include::/builds/sipa-ouest-france/platform/platform-api-blocktopus/target/generated-snippets/changelog.adoc[]