sites

Appliquer un plan de site

Le contenu complet d’un site en UN seul appel : informations sur l’entreprise, thème et navigation (fusionnés avec le brouillon), entrées, images (à fournir via images:place) et nom. Les entrées d’exemple du modèle de départ sont supprimées, sauf si le forfait les conserve. Tout est validé en même temps : si une partie est refusée, rien n’est enregistré et la réponse 400 indique tous les éléments à corriger. Une entrée d’historique est créée et la génération du site démarre. Gratuit : les images de la bibliothèque ne coûtent aucun crédit. Conçu pour une première version comme pour une refonte majeure.

POST/v1/sites/{site_id}/plan:apply

Request

curl --request POST \
  --url 'https://api.atelier201.com/v1/sites/<site_id>/plan:apply' \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "singletons": {},
  "entries": [
    {
      "collection": "<string>",
      "slug": "<string>"
    }
  ],
  "images": [
    {
      "target": "<string>",
      "alt": "<string>"
    }
  ],
  "keep_samples": true,
  "summary": "<string>"
}'

import json
import requests

url = "https://api.atelier201.com/v1/sites/<site_id>/plan:apply"
headers = {
  "Authorization": "<api-key>",
  "Content-Type": "application/json"
}
payload = json.loads("{\"name\":\"<string>\",\"singletons\":{},\"entries\":[{\"collection\":\"<string>\",\"slug\":\"<string>\"}],\"images\":[{\"target\":\"<string>\",\"alt\":\"<string>\"}],\"keep_samples\":true,\"summary\":\"<string>\"}")

response = requests.request("POST", url, headers=headers, json=payload)
print(response.json())

const response = await fetch("https://api.atelier201.com/v1/sites/<site_id>/plan:apply", {
  method: "POST",
  headers: {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "name": "<string>",
    "singletons": {},
    "entries": [
      {
        "collection": "<string>",
        "slug": "<string>"
      }
    ],
    "images": [
      {
        "target": "<string>",
        "alt": "<string>"
      }
    ],
    "keep_samples": true,
    "summary": "<string>"
  }),
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://api.atelier201.com/v1/sites/<site_id>/plan:apply");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: <api-key>",
    "Content-Type: application/json",
]);
curl_setopt($client, CURLOPT_POSTFIELDS, "{\"name\":\"<string>\",\"singletons\":{},\"entries\":[{\"collection\":\"<string>\",\"slug\":\"<string>\"}],\"images\":[{\"target\":\"<string>\",\"alt\":\"<string>\"}],\"keep_samples\":true,\"summary\":\"<string>\"}");
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

import (
  "bytes"
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("POST", "https://api.atelier201.com/v1/sites/<site_id>/plan:apply", bytes.NewBuffer([]byte("{\"name\":\"<string>\",\"singletons\":{},\"entries\":[{\"collection\":\"<string>\",\"slug\":\"<string>\"}],\"images\":[{\"target\":\"<string>\",\"alt\":\"<string>\"}],\"keep_samples\":true,\"summary\":\"<string>\"}")))
  req.Header.Set("Authorization", "<api-key>")
  req.Header.Set("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://api.atelier201.com/v1/sites/<site_id>/plan:apply"))
    .header("Authorization", "<api-key>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"name\":\"<string>\",\"singletons\":{},\"entries\":[{\"collection\":\"<string>\",\"slug\":\"<string>\"}],\"images\":[{\"target\":\"<string>\",\"alt\":\"<string>\"}],\"keep_samples\":true,\"summary\":\"<string>\"}"))
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://api.atelier201.com/v1/sites/<site_id>/plan:apply")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "<api-key>"
request["Content-Type"] = "application/json"
request.body = "{\"name\":\"<string>\",\"singletons\":{},\"entries\":[{\"collection\":\"<string>\",\"slug\":\"<string>\"}],\"images\":[{\"target\":\"<string>\",\"alt\":\"<string>\"}],\"keep_samples\":true,\"summary\":\"<string>\"}"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/json

{
  "data": {
    "renamed": null,
    "singletons": [
      "<string>"
    ],
    "saved": 123,
    "deleted": 123,
    "images": [
      {
        "target": "<string>",
        "image": null,
        "credit": null,
        "warning": null
      }
    ],
    "revision": "<string>",
    "changed": true,
    "build": {
      "id": "<string>",
      "state": "<string>",
      "next_action": "<string>"
    },
    "next_action": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

Nécessite sites:write. Ne coûte aucun crédit : les images de la bibliothèque sont gratuites. Le chemin se termine par /plan:apply. Les changements ne concernent que le brouillon. Les visiteurs ne voient rien tant que vous n’avez pas publié.

Le moyen le plus rapide de rédiger une première version d’un site ou d’en remanier un : tout ce qu’il faut pour une première version, dans une seule requête. Consultez d’abord le modèle de contenu pour connaître les champs.

name : le nom du site dans Atelier201.
singletons : business, theme, navigation… Chaque élément est fusionné avec le contenu du brouillon, clé par clé au niveau supérieur ; un groupe imbriqué fourni, comme hero ou colors, remplace ce groupe.
entries : jusqu’à 200 entrées à créer, modifier ou supprimer, selon le format accepté par Enregistrer plusieurs entrées.
images : jusqu’à 12 images, selon le format accepté par Insérer une image dans un champ image : target, alt et l’un des champs query, stock_id ou media_path. Si une image est introuvable, le résultat contient un warning et le reste du plan est tout de même appliqué.
keep_samples : les exemples d’entrées du modèle de départ (service-one, service-two) sont supprimés, sauf si le plan les renseigne ou si la valeur est true.

Tout est validé avant la moindre écriture. Si une partie est refusée, rien n’est enregistré et le 400 répertorie tous les éléments à corriger, pour que vous puissiez tout régler en une fois. En cas de réussite, une seule entrée est ajoutée à l’historique et la compilation démarre : la réponse contient build. Ensuite, vérifiez la publication : elle est refusée tant qu’il reste du texte d’exemple du modèle de départ.

Autorisations

Authorizationbearerin headerrequired

Paramètres de chemin

site_idstringrequired

L’identifiant du site ou son slug (l’adresse avant .atelier201.page).

Corps

application/jsonrequired

namestringlength: 1–80 chars

Le nom du site dans Atelier201 (le nom de l’entreprise).

singletonsRecord<string, Record<string, object>>

business, theme, navigation... : chaque groupe est fusionné avec le contenu du brouillon (clés de premier niveau ; un groupe imbriqué fourni ici remplace ce groupe). Les champs sont ceux définis par get_content_model.

entriesobject[]items: 1–200 items

Entrées à créer, modifier ou supprimer (delete: true), au format accepté par save_entries, jusqu’à 200.

Show child attributes

entries.collectionstringrequired

entries.slugstringrequired

Lettres minuscules, chiffres et traits d’union.

entries.dataRecord<string, object>

Les champs définis par le schéma de la collection (à omettre en cas de suppression).

entries.bodystringlength: ≤ 500000 chars

Corps en Markdown, pour les collections de contenu.

entries.deleteboolean

true pour supprimer cette entrée.

imagesobject[]items: ≤ 12 items

Images à renseigner dans les champs image, au format attendu par place_image (target, alt et l’un des champs query, stock_id ou media_path). Si une image est introuvable, un avertissement est renvoyé ; les autres modifications sont tout de même appliquées.

Show child attributes

images.targetstringrequiredlength: 3–200 chars

Le champ image : business:/hero/image pour les informations de l’entreprise, ou /:/image pour une entrée (services/sourdough:/image). get_content_model indique les champs image.

images.altstringrequiredlength: 1–300 chars

Description de l’image pour les personnes qui ne peuvent pas la voir, dans la langue du site. Elle est enregistrée dans le champ alt, à côté de l’image, lorsqu’il existe.

images.querystringlength: ≤ 100 chars

Description à rechercher dans la bibliothèque d’images libres de droits, en anglais et avec des termes concrets ("minimalist concrete house at dusk") : le premier résultat est importé.

images.stock_idstringlength: ≤ 20 chars

ID d’un résultat de search_stock_media, si vous avez choisi l’image vous-même.

images.media_pathstringlength: ≤ 200 chars

Fichier déjà présent dans les médias du site (/media/storefront.jpg), par exemple une photo du propriétaire.

images.orientationenum<string>one of: landscape, portrait, square

Avec query : format de l’image à rechercher. Landscape convient à une image hero.

keep_samplesboolean

Conservez les entrées d’exemple du modèle de départ (service-one, service-two). Par défaut, elles sont supprimées, sauf si le plan les crée.

summarystringlength: ≤ 200 chars

Une phrase pour l’historique.

Réponse

application/json

Appliquer un forfait à un site

dataRecord<string, object>required

Show child attributes

data.renamedstringnullrequired

data.singletonsstring[]required

Les éléments singleton enregistrés.

data.savedintegerrequiredrange: -9007199254740991–9007199254740991

data.deletedintegerrequiredrange: -9007199254740991–9007199254740991

data.imagesobject[]required

Show child attributes

data.images.targetstringrequired

data.images.imagestringnullrequired

data.images.creditstringnullrequired

data.images.warningstringnullrequired

data.revisionstring | nullrequired

data.changedbooleanrequired

data.buildobject | nullrequired

La génération démarrée (ou rejointe) par cette modification : l’aperçu la suit. Aucun appel à build_site n’est nécessaire.

Show child attributes

data.build.idstringrequired

data.build.statestringrequired

data.build.next_actionstringrequired

data.next_actionstringrequired

request_idstringrequired

Appliquer un plan de site

Autorisations

Paramètres de chemin

Corps

Réponse

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown

Cookies