publishing

Revisar antes de publicar

No cambia nada. Indica qué compilación se publicaría, si es la última del borrador, qué lo impide y qué valor de expected_generation enviar a publishSite para publicar únicamente ESTE estado revisado.

GET/v1/sites/{site_id}/publish/review

Request

curl --request GET \
  --url 'https://api.atelier201.com/v1/sites/<site_id>/publish/review' \
  --header 'Authorization: <api-key>'

import json
import requests

url = "https://api.atelier201.com/v1/sites/<site_id>/publish/review"
headers = {
  "Authorization": "<api-key>"
}

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

const response = await fetch("https://api.atelier201.com/v1/sites/<site_id>/publish/review", {
  method: "GET",
  headers: {
    "Authorization": "<api-key>"
  },
});

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>/publish/review");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: <api-key>",
]);
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

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

package main

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

func main() {
  req, _ := http.NewRequest("GET", "https://api.atelier201.com/v1/sites/<site_id>/publish/review", nil)
  req.Header.Set("Authorization", "<api-key>")
  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>/publish/review"))
    .header("Authorization", "<api-key>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .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>/publish/review")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "<api-key>"

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": {
    "site_id": "<string>",
    "url": "<string>",
    "platform_address": {
      "slug": "<string>",
      "domain": "<string>",
      "is_main": true
    },
    "build": {
      "id": "<string>",
      "site_id": "<string>",
      "revision": "<string>",
      "state": "queued",
      "target_origin": "<string>",
      "profile": "standard",
      "file_count": 123,
      "total_bytes": 123,
      "duration_ms": 123,
      "error": {
        "code": "<string>",
        "message": null
      },
      "warnings": [
        "<string>"
      ],
      "created_at": "<string>",
      "started_at": "<string>",
      "finished_at": "<string>"
    },
    "revision": "<string>",
    "draft_revision": "<string>",
    "is_latest_draft": true,
    "live_build_id": null,
    "expected_generation": 123,
    "can_publish": true,
    "blockers": [
      {
        "code": "<string>",
        "message": "<string>"
      }
    ],
    "warnings": [
      {
        "code": "<string>",
        "message": "<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:read. No modifica nada.

Llama a este endpoint antes de cada publicación y muestra a la persona el resultado. Envía expected_generation a Publicar una compilación para que solo se publique el estado revisado.

No se puede publicar una compilación mientras blockers no esté vacío. Cada elemento de bloqueo tiene un code y un message: guest_site, site_unavailable, plan_required (el sitio es un borrador: para publicar se necesita el plan Site), no_build, build_not_ready, origin_changed, manual_check (esta versión está pendiente de una comprobación rápida por nuestra parte; no hay nada que corregir) o older_than_draft. Consulta Cómo se publica un sitio.

Las warnings nunca bloquean la publicación. Léelas antes de publicar: sample_text indica, con el archivo y la línea, si queda algún texto de muestra, como Lorem ipsum.

Autorizaciones

Authorizationbearerin headerrequired

Parámetros de ruta

site_idstringrequired

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

Parámetros de consulta

build_idstring<uuid>pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

allow_older_buildboolean

Revisar una compilación anterior al borrador para publicarla (en ese caso, older_than_draft es una advertencia, no un impedimento).

Respuesta

application/json

Revisar antes de publicar

dataobjectrequired

Show child attributes

data.site_idstringrequired

data.urlstringrequired

data.platform_addressobjectrequired

La dirección incluida con el sitio, que se cambia con set_site_address. is_main: los visitantes acceden a ella si ningún dominio personalizado la ha sustituido.

Show child attributes

data.platform_address.slugstringrequired

data.platform_address.domainstringrequired

data.platform_address.is_mainbooleanrequired

data.buildobject | nullrequired

Show child attributes

data.build.idstringrequired

data.build.site_idstringrequired

data.build.revisionstringrequiredlength: 40–40 chars

Un ID de commit de Git (40 caracteres hexadecimales) del repositorio del sitio.

data.build.stateenum<string>requiredone of: queued, building, collecting, ready, failed, cancelled

data.build.target_originstringrequired

data.build.profileenum<string>requiredone of: standard, guest-demo

data.build.file_countinteger | nullrequired

data.build.total_bytesinteger | nullrequired

data.build.duration_msinteger | nullrequired

data.build.errorobject | nullrequired

Show child attributes

data.build.error.codestringrequired

data.build.error.messagestringnullrequired

data.build.warningsstring[]required

data.build.created_atstringrequired

ISO 8601, UTC.

data.build.started_atstring | nullrequired

data.build.finished_atstring | nullrequired

data.revisionstring | nullrequired

data.draft_revisionstring | nullrequired

data.is_latest_draftbooleanrequired

data.live_build_idstringnullrequired

data.expected_generationintegerrequiredrange: -9007199254740991–9007199254740991

data.can_publishbooleanrequired

data.blockersobject[]required

Show child attributes

data.blockers.codestringrequired

data.blockers.messagestringrequired

data.warningsobject[]required

Permitido, pero conviene decidirlo. Aquí, older_than_draft significa que la compilación revisada es anterior al borrador y se ha permitido (allow_older_build), o que no se ha indicado ningún build_id.

Show child attributes

data.warnings.codestringrequired

data.warnings.messagestringrequired

request_idstringrequired

{ "data": { "site_id": "<string>", "url": "<string>", "platform_address": { "slug": "<string>", "domain": "<string>", "is_main": true }, "build": { "id": "<string>", "site_id": "<string>", "revision": "<string>", "state": "queued", "target_origin": "<string>", "profile": "standard", "file_count": 123, "total_bytes": 123, "duration_ms": 123, "error": { "code": "<string>", "message": null }, "warnings": [ "<string>" ], "created_at": "<string>", "started_at": "<string>", "finished_at": "<string>" }, "revision": "<string>", "draft_revision": "<string>", "is_latest_draft": true, "live_build_id": null, "expected_generation": 123, "can_publish": true, "blockers": [ { "code": "<string>", "message": "<string>" } ], "warnings": [ { "code": "<string>", "message": "<string>" } ] }, "request_id": "<string>" }

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

Revisar antes de publicar

Autorizaciones

Parámetros de ruta

Parámetros de consulta

Respuesta

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown

Cookies