sites

Einen Website-Plan anwenden

Der gesamte Inhalt einer Website in EINEM Aufruf: Geschäftsdaten, Theme und Navigation (werden mit dem Entwurf zusammengeführt), Einträge, Bilder (werden von images:place übernommen) und Name. Die Beispiel-Einträge des Starters werden gelöscht, sofern der Plan sie nicht beibehält. Alles wird gemeinsam validiert: Wird ein Teil abgelehnt, wird nichts gespeichert und die 400-Antwort listet alle zu korrigierenden Teile auf. Ein Verlaufseintrag, und der Build startet. Kostenlos: Stockbilder kosten keine Credits. Entwickelt für eine erste Version und umfangreiche Überarbeitungen.

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

Erfordert sites:write. Kostet keine Credits: Stockbilder sind kostenlos. Der Pfad endet mit /plan:apply. Änderungen betreffen nur den Entwurf. Besucher sehen nichts, bis Sie die Website veröffentlichen.

Der schnellste Weg, eine erste Version einer Website zu erstellen oder eine bestehende zu überarbeiten: alles, was eine erste Version braucht, in einer Anfrage. Lesen Sie zuerst das Inhaltsmodell, um sich über die Felder zu informieren.

name: der Name der Website in Atelier201.
singletons: business, theme, navigation… Jedes Element wird auf oberster Ebene Schlüssel für Schlüssel mit dem Inhalt des Entwurfs zusammengeführt. Eine übergebene verschachtelte Gruppe wie hero oder colors ersetzt die vorhandene Gruppe.
entries: bis zu 200 Einträge, die erstellt, aktualisiert oder gelöscht werden, wie bei Mehrere Einträge speichern.
images: bis zu 12 Bilder, wie bei Ein Bild in ein Bildfeld einfügen: target, alt und eines der Felder query, stock_id oder media_path. Kann ein Bild nicht gefunden werden, wird eine warning zurückgegeben und der restliche Plan trotzdem angewendet.
keep_samples: Die Beispiel-Einträge des Starters (service-one, service-two) werden gelöscht, sofern der Plan sie nicht enthält oder dieser Wert nicht auf true gesetzt ist.

Alles wird geprüft, bevor etwas gespeichert wird. Wird ein Teil abgelehnt, wird nichts gespeichert und die 400-Antwort listet alle zu korrigierenden Punkte auf, damit Sie sie in einem Durchgang beheben können. Bei Erfolg wird ein einzelner Verlaufseintrag angelegt und der Build gestartet: Die Antwort enthält build. Prüfen Sie anschließend die Veröffentlichung: Sie wird abgelehnt, solange noch Beispieltexte des Starters vorhanden sind.

Autorisierung

Authorizationbearerin headerrequired

Pfadparameter

site_idstringrequired

ID der Website oder ihr Slug (die Adresse vor .atelier201.page).

Body

application/jsonrequired

namestringlength: 1–80 chars

Der Name der Website in Atelier201 (der Geschäftsname).

singletonsRecord<string, Record<string, object>>

business, theme, navigation ...: jeweils mit den Werten im Entwurf zusammengeführt (Top-Level-Schlüssel; eine hier angegebene verschachtelte Gruppe ersetzt diese Gruppe). Felder gemäß get_content_model.

entriesobject[]items: 1–200 items

Einträge zum Erstellen, Aktualisieren oder Löschen (delete: true), im Format von save_entries, bis zu 200.

Show child attributes

entries.collectionstringrequired

entries.slugstringrequired

Kleinbuchstaben, Ziffern und Bindestriche.

entries.dataRecord<string, object>

Felder gemäß dem Schema der Collection (nicht bei delete).

entries.bodystringlength: ≤ 500000 chars

Markdown-Text für Content-Collections.

entries.deleteboolean

true, um diesen Eintrag zu löschen.

imagesobject[]items: ≤ 12 items

Bilder für Bildfelder, wie place_image sie erwartet (target, alt und eines von query, stock_id oder media_path). Ein Bild, das nicht gefunden wird, führt zu einer Warnung. Die übrigen Änderungen werden trotzdem angewendet.

Show child attributes

images.targetstringrequiredlength: 3–200 chars

Das Bildfeld: business:/hero/image für Unternehmensdetails oder /:/image für einen Eintrag (services/sourdough:/image). get_content_model zeigt die Bildfelder an.

images.altstringrequiredlength: 1–300 chars

Beschreibt in der Sprache der Website, was auf dem Bild zu sehen ist, für Menschen, die es nicht sehen können. Wird neben dem Bild im Feld alt gespeichert, sofern dieses vorhanden ist.

images.querystringlength: ≤ 100 chars

Eine Suchbeschreibung für die kostenlose Stock-Bibliothek. Auf Englisch und mit konkreten Begriffen, etwa „minimalist concrete house at dusk“: Das erste Ergebnis wird importiert.

images.stock_idstringlength: ≤ 20 chars

Eine Ergebnis-ID von search_stock_media, wenn du das Bild selbst ausgewählt hast.

images.media_pathstringlength: ≤ 200 chars

Eine Datei, die sich bereits in den Medien der Website befindet (/media/storefront.jpg), zum Beispiel ein eigenes Foto des Inhabers.

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

Mit query: das gesuchte Format. Landscape eignet sich für ein Hero-Bild.

keep_samplesboolean

Die Beispiel-Einträge des Starters beibehalten (service-one, service-two). Standardmäßig werden sie gelöscht, sofern der Plan sie nicht erstellt.

summarystringlength: ≤ 200 chars

Ein Satz für den Änderungsverlauf.

Antwort

application/json

Website-Plan anwenden

dataRecord<string, object>required

Show child attributes

data.renamedstringnullrequired

data.singletonsstring[]required

Die geschriebenen Singletons.

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

Der Build, den diese Änderung gestartet oder übernommen hat: Die Vorschau folgt diesem Build. Kein Aufruf von build_site erforderlich.

Show child attributes

data.build.idstringrequired

data.build.statestringrequired

data.build.next_actionstringrequired

data.next_actionstringrequired

request_idstringrequired

Einen Website-Plan anwenden

Autorisierung

Pfadparameter

Body

Antwort

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown

Cookies