publishing

Vérifier avant publication

Ne modifie rien. Indique quel build serait mis en ligne, s’il s’agit du dernier brouillon, ce qui bloque sa publication et la valeur expected_generation à transmettre à publishSite afin que seul l’état vérifié soit publié.

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

Nécessite sites:read. Cette opération ne modifie rien.

Appelez cette opération avant chaque publication et affichez son résultat à la personne concernée. Transmettez expected_generation à Publier une version afin que seule la version vérifiée soit mise en ligne.

Une version ne peut pas être publiée tant que blockers n’est pas vide. Chaque élément bloquant comporte un code et un message : guest_site, site_unavailable, plan_required (le site est un brouillon : sa publication nécessite le forfait Site), no_build, build_not_ready, origin_changed, manual_check (cette version attend une vérification rapide de notre part : aucune correction n’est nécessaire) ou older_than_draft. Consultez Comment un site est mis en ligne.

Les warnings ne bloquent jamais la publication. Consultez-les avant de publier : sample_text indique, avec le fichier et la ligne, les éventuels textes d’exemple restants, comme Lorem ipsum.

Autorisations

Authorizationbearerin headerrequired

Paramètres de chemin

site_idstringrequired

L’identifiant du site ou son slug (l’adresse avant .atelier201.page).

Paramètres de requête

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

Vérifier un build antérieur au brouillon en tant que build que vous souhaitez mettre en ligne (older_than_draft est alors un avertissement, pas un blocage).

Réponse

application/json

Vérifier avant publication

dataobjectrequired

Show child attributes

data.site_idstringrequired

data.urlstringrequired

data.platform_addressobjectrequired

L’adresse incluse avec le site, que set_site_address modifie. is_main : les visiteurs arrivent à cette adresse, aucun domaine personnalisé ne l’a remplacée.

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 identifiant de commit Git (40 caractères hexadécimaux) du dépôt du site.

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

Autorisé, mais mérite une décision. Ici, older_than_draft signifie que le build vérifié est antérieur au brouillon et a été autorisé (allow_older_build), ou qu’aucun build_id n’a été indiqué.

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

Vérifier avant publication

Autorisations

Paramètres de chemin

Paramètres de requête

Réponse

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown

Cookies