sites

Aplicar un plan de sitio

Todo el contenido de un sitio en UNA sola llamada: datos del negocio, tema y navegación (combinados con el borrador), entradas, imágenes (las acepta images:place) y nombre. Se eliminan las entradas de muestra del sitio inicial, salvo que el plan las conserve. Todo se valida a la vez: si se rechaza alguna parte, no se escribe nada y el 400 indica todas las partes que hay que corregir. Se crea una única entrada en el historial y se inicia la compilación. Gratis: las imágenes de archivo no cuestan créditos. Pensado para una primera versión y para una revisión a fondo.

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>"
}

Requiere sites:write. No cuesta créditos: las imágenes de stock son gratuitas. La ruta termina en /plan:apply. Solo modifica el borrador. Los visitantes no verán nada hasta que publiques.

La forma más rápida de crear la primera versión de un sitio o rehacer uno: todo lo que necesita una primera versión, en una sola solicitud. Lee primero el modelo de contenido para consultar los campos.

name: el nombre del sitio en Atelier201.
singletons: business, theme, navigation… Cada elemento se combina con lo que ya hay en el borrador, clave por clave en el nivel superior; los grupos anidados que envíes, como hero o colors, sustituyen al grupo correspondiente.
entries: hasta 200 entradas para crear, actualizar o eliminar, con el formato que acepta Guardar varias entradas.
images: hasta 12 imágenes, con el formato que acepta Añadir una imagen a un campo de imagen: target, alt y uno de estos campos: query, stock_id o media_path. Si no se encuentra una imagen, se devuelve una warning y el resto del plan se aplica igualmente.
keep_samples: las entradas de ejemplo de la plantilla inicial (service-one, service-two) se eliminan, salvo que el plan las incluya o que este valor sea true.

Todo se valida antes de escribir nada. Si se rechaza alguna parte, no se guarda nada y la respuesta 400 enumera todas las partes que hay que corregir para que puedas solucionarlas de una vez. Si la operación se completa correctamente, se crea una sola entrada del historial y se inicia la compilación: la respuesta incluye build. Después, revisa la publicación: se rechazará mientras quede algún texto de ejemplo de la plantilla inicial.

Autorizaciones

Authorizationbearerin headerrequired

Parámetros de ruta

site_idstringrequired

El ID del sitio o su slug (la dirección antes de .atelier201.page).

Cuerpo

application/jsonrequired

namestringlength: 1–80 chars

El nombre del sitio en Atelier201 (el nombre del negocio).

singletonsRecord<string, Record<string, object>>

business, theme, navigation...: cada grupo se combina con lo que contiene el borrador (claves de nivel superior; si se proporciona un grupo anidado, sustituye a ese grupo). Los campos se definen en get_content_model.

entriesobject[]items: 1–200 items

Entradas que se deben crear, actualizar o eliminar (delete: true), con el formato que acepta save_entries, hasta 200.

Show child attributes

entries.collectionstringrequired

entries.slugstringrequired

Letras minúsculas, dígitos y guiones.

entries.dataRecord<string, object>

Los campos definidos en el esquema de la colección (no se aplica a delete).

entries.bodystringlength: ≤ 500000 chars

Cuerpo en Markdown, para colecciones de contenido.

entries.deleteboolean

true para eliminar esta entrada.

imagesobject[]items: ≤ 12 items

Imágenes que se asignan a campos de imagen, con el formato que acepta place_image (target, alt y uno de estos valores: query, stock_id, media_path). Si no se encuentra una imagen, se muestra una advertencia; el resto se aplica igualmente.

Show child attributes

images.targetstringrequiredlength: 3–200 chars

El campo de imagen: business:/hero/image para los datos de la empresa o /:/image para una entrada (services/sourdough:/image). get_content_model muestra los campos de imagen.

images.altstringrequiredlength: 1–300 chars

Qué muestra la imagen, para las personas que no pueden verla, en el idioma del sitio. Se guarda en el campo alt junto a la imagen, si lo hay.

images.querystringlength: ≤ 100 chars

Descripción para buscar en la biblioteca de imágenes gratuitas. Escríbela en inglés con términos concretos ("minimalist concrete house at dusk"). Se importa el primer resultado.

images.stock_idstringlength: ≤ 20 chars

ID de un resultado de search_stock_media, si has elegido la imagen manualmente.

images.media_pathstringlength: ≤ 200 chars

Archivo que ya está en la carpeta de medios del sitio (/media/storefront.jpg), por ejemplo, una foto del propietario.

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

Con query: la orientación que se debe buscar. El formato apaisado es adecuado para una imagen principal.

keep_samplesboolean

Conserva las entradas de ejemplo del Starter (service-one, service-two). De forma predeterminada, se eliminan salvo que el plan las incluya.

summarystringlength: ≤ 200 chars

Una frase para el historial.

Respuesta

application/json

Aplicar un plan a un sitio

dataRecord<string, object>required

Show child attributes

data.renamedstringnullrequired

data.singletonsstring[]required

Los elementos únicos escritos.

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 compilación que inició este cambio (o a la que se incorporó): la vista previa la sigue. No hace falta llamar a build_site.

Show child attributes

data.build.idstringrequired

data.build.statestringrequired

data.build.next_actionstringrequired

data.next_actionstringrequired

request_idstringrequired

Aplicar un plan de sitio

Autorizaciones

Parámetros de ruta

Cuerpo

Respuesta

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown

Cookies