sites

Aplicar um plano ao site

Todo o conteúdo de um site em UMA chamada: dados da empresa, tema e navegação (mesclados ao rascunho), entradas, imagens (recebidas por images:place) e nome. As entradas de exemplo do starter são excluídas, a menos que o plano as mantenha. Tudo é validado em conjunto: se qualquer parte for recusada, nada é gravado e a resposta 400 lista tudo que precisa ser corrigido. Uma entrada no histórico, e a compilação é iniciada. Grátis: imagens de banco não custam créditos. Ideal para uma primeira versão e para uma reformulação ampla.

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

Requer sites:write. Não consome créditos: as imagens de banco são gratuitas. O caminho termina em /plan:apply. Altera apenas o rascunho. Os visitantes não veem nada até você publicar.

A maneira mais rápida de criar a primeira versão de um site ou reformular um que já existe: tudo o que uma primeira versão precisa, em uma única solicitação. Consulte primeiro o modelo de conteúdo para conhecer os campos.

name: o nome do site no Atelier201.
singletons: business, theme, navigation… Cada item é mesclado ao conteúdo atual do rascunho, chave por chave no nível superior; um grupo aninhado que você fornecer (como hero ou colors) substitui o grupo inteiro.
entries: até 200 entradas para criar, atualizar ou excluir, no formato aceito por Salvar várias entradas.
images: até 12 imagens, no formato aceito por Inserir uma imagem em um campo de imagem: target, alt e um dos campos query, stock_id ou media_path. Se não for possível encontrar uma imagem, a resposta inclui warning, e o restante do plano ainda é aplicado.
keep_samples: as entradas de exemplo do Starter (service-one, service-two) são excluídas, a menos que o plano as grave ou que o valor seja true.

Tudo é validado antes de qualquer gravação. Se alguma parte for recusada, nada será salvo e o 400 listará tudo o que precisa ser corrigido, para que você resolva tudo de uma só vez. Se a operação for bem-sucedida, será criada uma única entrada no histórico e a compilação começará: a resposta incluirá build. Depois, revise a publicação: ela será recusada enquanto ainda houver qualquer texto de exemplo do Starter.

Autorizações

Authorizationbearerin headerrequired

Parâmetros de caminho

site_idstringrequired

O id do site ou seu slug (o endereço antes de .atelier201.page).

Corpo

application/jsonrequired

namestringlength: 1–80 chars

O nome do site no Atelier201 (o nome da empresa).

singletonsRecord<string, Record<string, object>>

business, theme, navigation...: cada grupo é mesclado ao conteúdo atual do rascunho (chaves de nível superior; um grupo aninhado informado aqui substitui esse grupo). Os campos seguem a definição de get_content_model.

entriesobject[]items: 1–200 items

Entradas a criar, atualizar ou excluir (delete: true), no formato aceito por save_entries, até 200.

Show child attributes

entries.collectionstringrequired

entries.slugstringrequired

Letras minúsculas, dígitos e hífens.

entries.dataRecord<string, object>

Os campos, conforme definidos pelo esquema da coleção (não se aplica à exclusão).

entries.bodystringlength: ≤ 500000 chars

Corpo em Markdown, para coleções de conteúdo.

entries.deleteboolean

true para excluir esta entrada.

imagesobject[]items: ≤ 12 items

Imagens a inserir em campos de imagem, no formato aceito por place_image (target, alt e um entre query, stock_id e media_path). Se uma imagem não for encontrada, será emitido um aviso; as demais alterações ainda serão aplicadas.

Show child attributes

images.targetstringrequiredlength: 3–200 chars

O campo de imagem: business:/hero/image para os dados da empresa ou /:/image para um registro (services/sourdough:/image). get_content_model mostra os campos de imagem.

images.altstringrequiredlength: 1–300 chars

O que a imagem mostra, para pessoas que não conseguem vê-la, no idioma do site. O texto é salvo no campo alt ao lado da imagem, quando disponível.

images.querystringlength: ≤ 100 chars

Uma descrição para buscar na biblioteca de imagens gratuitas, em inglês e com termos concretos ("minimalist concrete house at dusk"): o primeiro resultado é importado.

images.stock_idstringlength: ≤ 20 chars

O ID de um resultado de search_stock_media, quando você escolheu a imagem.

images.media_pathstringlength: ≤ 200 chars

Um arquivo que já está na mídia do site (/media/storefront.jpg), por exemplo, uma foto do proprietário.

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

Com query: o formato da imagem a buscar. Landscape é adequado para uma imagem de destaque.

keep_samplesboolean

Manter os registros de exemplo do starter (service-one, service-two). Por padrão, eles são excluídos, a menos que o plano os crie.

summarystringlength: ≤ 200 chars

Uma frase para o histórico.

Resposta

application/json

Aplicar um plano ao site

dataRecord<string, object>required

Show child attributes

data.renamedstringnullrequired

data.singletonsstring[]required

Os singletons gravados.

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

A compilação iniciada (ou associada) por esta alteração: a prévia acompanha essa compilação. Não é necessário chamar build_site.

Show child attributes

data.build.idstringrequired

data.build.statestringrequired

data.build.next_actionstringrequired

data.next_actionstringrequired

request_idstringrequired

Aplicar um plano ao site

Autorizações

Parâmetros de caminho

Corpo

Resposta

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown

Cookies