publishing

Controllare prima della pubblicazione

Non modifica nulla. Indica quale build verrebbe pubblicata, se è la bozza più recente, cosa ne impedisce la pubblicazione e quale expected_generation inviare a publishSite, così da pubblicare SOLO lo stato esaminato.

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

Richiede sites:read. Non apporta modifiche.

Chiama questo endpoint prima di ogni pubblicazione e mostra alla persona il risultato. Invia expected_generation a Pubblicare una build, così verrà pubblicato solo lo stato verificato.

Non è possibile pubblicare una build se blockers non è vuoto. Ogni elemento che blocca la pubblicazione include un code e un message: guest_site, site_unavailable, plan_required (il sito è una bozza: per pubblicarlo serve il piano Site), no_build, build_not_ready, origin_changed, manual_check (questa versione è in attesa di un rapido controllo da parte nostra: non c’è nulla da correggere) oppure older_than_draft. Consulta Come viene pubblicato un sito.

Le warnings non bloccano la pubblicazione. Leggile prima di pubblicare: sample_text indica, con file e riga, l’eventuale testo di esempio rimasto, come Lorem ipsum.

Autorizzazioni

Authorizationbearerin headerrequired

Parametri di percorso

site_idstringrequired

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

Parametri di query

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

Esamina una build precedente alla bozza come quella che intendi pubblicare (in tal caso, older_than_draft è un avviso, non un impedimento).

Risposta

application/json

Esamina prima della pubblicazione

dataobjectrequired

Show child attributes

data.site_idstringrequired

data.urlstringrequired

data.platform_addressobjectrequired

L'indirizzo incluso nel sito, modificato da set_site_address. is_main: i visitatori arrivano qui, se nessun dominio personalizzato lo ha sostituito.

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

ID di un commit Git (40 caratteri esadecimali) del repository del sito.

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

Consentito, ma merita una valutazione. Qui older_than_draft significa che la build esaminata è precedente alla bozza ed è stata consentita (allow_older_build), oppure che non è stato specificato alcun 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>" }

Controllare prima della pubblicazione

Autorizzazioni

Parametri di percorso

Parametri di query

Risposta

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown

Cookie