publishing

Publier une compilation

VISIBLE SUR INTERNET. Seul un site avec l’offre Site peut être publié : la publication d’un brouillon est refusée avec 403 feature_not_available et une action_url vers son offre. Ce build précis (ou, si build_id est omis, le brouillon dans son état actuel, après génération si nécessaire) devient ce que les visiteurs voient à toutes les adresses du site, en environ une minute. La publication est refusée avec 409 si le site a été publié, restauré à une version antérieure ou mis hors ligne depuis votre vérification (expected_generation). Nécessite sites:publish.

POST/v1/sites/{site_id}/publish

Request

curl --request POST \
  --url 'https://api.atelier201.com/v1/sites/<site_id>/publish' \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "expected_generation": 123
}'

import json
import requests

url = "https://api.atelier201.com/v1/sites/<site_id>/publish"
headers = {
  "Authorization": "<api-key>",
  "Content-Type": "application/json"
}
payload = json.loads("{\"expected_generation\":123}")

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

const response = await fetch("https://api.atelier201.com/v1/sites/<site_id>/publish", {
  method: "POST",
  headers: {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "expected_generation": 123
  }),
});

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");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: <api-key>",
    "Content-Type: application/json",
]);
curl_setopt($client, CURLOPT_POSTFIELDS, "{\"expected_generation\":123}");
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>/publish", bytes.NewBuffer([]byte("{\"expected_generation\":123}")))
  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>/publish"))
    .header("Authorization", "<api-key>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"expected_generation\":123}"))
    .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")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "<api-key>"
request["Content-Type"] = "application/json"
request.body = "{\"expected_generation\":123}"

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>",
    "build_id": "<string>",
    "generation": 123,
    "url": "<string>",
    "visible_within_seconds": 123,
    "warnings": [
      {
        "code": "<string>",
        "message": "<string>"
      }
    ],
    "built": true
  },
  "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:publish et le rôle d’administrateur de l’espace de travail. Aucun crédit n’est facturé.

Cette action rend le site visible sur Internet. Ne publiez qu’après que le propriétaire a approuvé le contenu présenté dans la vérification. Un lien d’accès à la propriété ou une connexion ne constitue pas une approbation.

Si le site a été publié, restauré ou mis hors ligne depuis votre vérification, par vous ou par une autre personne, l’appel est refusé avec 409 conflict et rien ne change. Effectuez une nouvelle vérification. Une compilation comportant des blocages est refusée de la même façon, avec les blocages dans details.

Si build_id n’est pas indiqué, le brouillon dans son état actuel est mis en ligne, après compilation si nécessaire. Une valeur build_id antérieure au brouillon est refusée (older_than_draft), sauf si vous envoyez allow_older_build: true : mettre en ligne une version antérieure doit être un choix délibéré, pas un accident.

Autorisations

Authorizationbearerin headerrequired

Paramètres de chemin

site_idstringrequired

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

Corps

application/jsonrequired

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)$

Le build à publier. Omettez ce paramètre pour publier le brouillon dans son état actuel : il est généré au préalable si nécessaire, ce qui ajoute quelques secondes.

expected_generationintegerrequiredrange: 0–9007199254740991

allow_older_buildboolean

Requis pour publier volontairement un build antérieur au brouillon ; sinon, la publication est refusée (older_than_draft).

Réponse

application/json

Publier un build

dataobjectrequired

Show child attributes

data.site_idstringrequired

data.build_idstringrequired

data.generationintegerrequiredrange: -9007199254740991–9007199254740991

data.urlstringrequired

data.visible_within_secondsintegerrequiredrange: -9007199254740991–9007199254740991

data.warningsobject[]required

Ce qui a été mis en ligne avec un oubli : une ligne _redirects ignorée fait perdre une page déplacée. Corrigez-la, puis publiez à nouveau.

Show child attributes

data.warnings.codestringrequired

data.warnings.messagestringrequired

data.builtboolean

Vrai si le brouillon a dû être généré au préalable.

request_idstringrequired

curl --request POST \ --url 'https://api.atelier201.com/v1/sites/<site_id>/publish' \ --header 'Authorization: <api-key>' \ --header 'Content-Type: application/json' \ --data '{ "expected_generation": 123 }'

{ "data": { "site_id": "<string>", "build_id": "<string>", "generation": 123, "url": "<string>", "visible_within_seconds": 123, "warnings": [ { "code": "<string>", "message": "<string>" } ], "built": true }, "request_id": "<string>" }

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

Publier une compilation

Autorisations

Paramètres de chemin

Corps

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