sites

Applicare un piano al sito

Contenuti completi di un sito in UNA sola chiamata: dettagli dell'attività, tema e navigazione (integrati nella bozza), voci, immagini (da passare a images:place) e nome. Le voci di esempio del sito iniziale vengono eliminate, a meno che il piano non le mantenga. Tutto viene convalidato insieme: se una parte viene rifiutata, non viene scritto nulla e la risposta 400 elenca tutte le parti da correggere. Viene aggiunta una sola voce alla cronologia e la build viene avviata. Gratis: le immagini di repertorio non costano crediti. Ideale per una prima versione e per una revisione completa.

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

Richiede sites:write. Non costa crediti: le immagini stock sono gratuite. Il percorso termina con /plan:apply. Le modifiche riguardano solo la bozza. I visitatori non vedranno nulla finché non pubblichi.

Il modo più rapido per creare la prima versione di un sito o rielaborarne uno: tutto ciò che serve per una prima versione, in un’unica richiesta. Per conoscere i campi, leggi prima il modello dei contenuti.

name: il nome del sito in Atelier201.
singletons: business, theme, navigation… Ogni elemento viene unito a ciò che è presente nella bozza, chiave per chiave al livello principale; un gruppo annidato fornito (come hero o colors) sostituisce il gruppo corrispondente.
entries: fino a 200 elementi da creare, aggiornare o eliminare, nel formato previsto da Salvare più elementi.
images: fino a 12 immagini, nel formato previsto da Inserire un’immagine in un campo immagine: target, alt e uno tra query, stock_id o media_path. Se un’immagine non viene trovata, la risposta include un warning e il resto del piano viene comunque applicato.
keep_samples: gli elementi di esempio dello starter (service-one, service-two) vengono eliminati, a meno che il piano non li crei o che questo valore sia true.

Tutto viene convalidato prima di salvare qualsiasi modifica. Se una parte viene rifiutata, non viene salvato nulla e la risposta 400 elenca tutte le parti da correggere, così puoi sistemarle in un solo passaggio. Se l’operazione riesce, viene creata una sola voce nella cronologia e si avvia la compilazione: la risposta include build. In seguito, verifica la pubblicazione: l’operazione viene rifiutata se è rimasto del testo di esempio dello starter.

Autorizzazioni

Authorizationbearerin headerrequired

Parametri di percorso

site_idstringrequired

L'ID del sito o il suo slug (l'indirizzo prima di .atelier201.page).

Corpo

application/jsonrequired

namestringlength: 1–80 chars

Il nome del sito in Atelier201 (il nome dell'attività).

singletonsRecord<string, Record<string, object>>

business, theme, navigation...: ciascun elemento viene integrato nei dati presenti nella bozza (chiavi di primo livello; un gruppo nidificato fornito qui sostituisce quel gruppo). I campi sono quelli definiti da get_content_model.

entriesobject[]items: 1–200 items

Voci da creare, aggiornare o eliminare (delete: true), nel formato accettato da save_entries, fino a 200.

Show child attributes

entries.collectionstringrequired

entries.slugstringrequired

Lettere minuscole, cifre e trattini.

entries.dataRecord<string, object>

I campi, come definiti dallo schema della raccolta (non per l'eliminazione).

entries.bodystringlength: ≤ 500000 chars

Corpo in Markdown, per le raccolte di contenuti.

entries.deleteboolean

true per eliminare questa voce.

imagesobject[]items: ≤ 12 items

Immagini da inserire nei campi immagine, nel formato richiesto da place_image (target, alt e uno tra query, stock_id e media_path). Se un'immagine non viene trovata, viene segnalato un avviso; il resto viene comunque applicato.

Show child attributes

images.targetstringrequiredlength: 3–200 chars

Il campo immagine: business:/hero/image per i dettagli dell'attività oppure /:/image per una voce (services/sourdough:/image). get_content_model mostra i campi immagine.

images.altstringrequiredlength: 1–300 chars

Descrizione di ciò che mostra l'immagine, per chi non può vederla, nella lingua del sito. Se presente, viene salvata nel campo alt accanto all'immagine.

images.querystringlength: ≤ 100 chars

Descrizione da cercare nella libreria di immagini stock gratuite, in inglese e con termini concreti ("minimalist concrete house at dusk"): viene importato il primo risultato.

images.stock_idstringlength: ≤ 20 chars

ID di un risultato di search_stock_media, se hai scelto personalmente l'immagine.

images.media_pathstringlength: ≤ 200 chars

File già presente nei contenuti multimediali del sito (/media/storefront.jpg), ad esempio una foto del proprietario.

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

Con query: il formato da cercare. Per un hero è adatto Landscape.

keep_samplesboolean

Mantieni le voci di esempio dello starter (service-one, service-two). Per impostazione predefinita, vengono eliminate se il piano non le crea.

summarystringlength: ≤ 200 chars

Una frase per la cronologia.

Risposta

application/json

Applica un piano al sito

dataRecord<string, object>required

Show child attributes

data.renamedstringnullrequired

data.singletonsstring[]required

I singleton scritti.

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 build avviata (o a cui si è unita) questa modifica: l'anteprima la segue. Non serve chiamare build_site.

Show child attributes

data.build.idstringrequired

data.build.statestringrequired

data.build.next_actionstringrequired

data.next_actionstringrequired

request_idstringrequired

Applicare un piano al sito

Autorizzazioni

Parametri di percorso

Corpo

Risposta

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown

Cookie