sites

Récupérer un site

L’adresse du site, son forfait, sa révision brouillon et sa version publiée. Un site appartenant à un autre espace de travail renvoie 404.

GET/v1/sites/{site_id}

Request

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

import json
import requests

url = "https://api.atelier201.com/v1/sites/<site_id>"
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>", {
  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>");
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>", 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>"))
    .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>")
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": {
    "id": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "status": "creating",
    "plan": "free",
    "url": "<string>",
    "platform_url": "<string>",
    "guest": true,
    "draft": {
      "revision": "<string>",
      "updated_at": "<string>"
    },
    "published": {
      "build_id": "<string>",
      "generation": 123,
      "published_at": "<string>"
    },
    "generation": 123,
    "cover_at": "<string>",
    "created_at": "<string>",
    "updated_at": "<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.

Renvoyez generation sous le nom expected_generation lors d’une publication, d’un retour à une version précédente ou d’une dépublication. Pour un site appartenant à un autre espace de travail, la réponse est 404, comme pour un site inexistant.

Autorisations

Authorizationbearerin headerrequired

Paramètres de chemin

site_idstringrequired

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

Réponse

application/json

Récupérer un site

dataobjectrequired

Show child attributes

data.idstringrequired

data.namestringrequired

data.slugstringrequired

data.statusenum<string>requiredone of: creating, ready, suspended, deleting

data.planenum<string>requiredone of: free, site

data.urlstringrequired

L’adresse à laquelle les visiteurs trouvent le site : son domaine personnalisé principal ou son adresse atelier201.page.

data.platform_urlstringrequired

data.guestbooleanrequired

Préparé par un agent avant la connexion et pas encore revendiqué : le site peut être prévisualisé, mais pas publié.

data.draftobjectrequired

Show child attributes

data.draft.revisionstring | nullrequired

data.draft.updated_atstring | nullrequired

data.publishedobject | nullrequired

Show child attributes

data.published.build_idstringrequired

data.published.generationintegerrequiredrange: -9007199254740991–9007199254740991

data.published.published_atstring | nullrequired

data.generationintegerrequiredrange: -9007199254740991–9007199254740991

Augmente à chaque publication, restauration ou dépublication. Renvoyez cette valeur sous forme de expected_generation.

data.cover_atstring | nullrequired

Date de la dernière capture de l’image de la page d’accueil affichée par l’application sur la carte du site, après une compilation du site. Null avant la première capture.

data.created_atstringrequired

ISO 8601, UTC.

data.updated_atstringrequired

ISO 8601, UTC.

request_idstringrequired

{ "data": { "id": "<string>", "name": "<string>", "slug": "<string>", "status": "creating", "plan": "free", "url": "<string>", "platform_url": "<string>", "guest": true, "draft": { "revision": "<string>", "updated_at": "<string>" }, "published": { "build_id": "<string>", "generation": 123, "published_at": "<string>" }, "generation": 123, "cover_at": "<string>", "created_at": "<string>", "updated_at": "<string>" }, "request_id": "<string>" }

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

Récupérer un site

Autorisations

Paramètres de chemin

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