builds

Consultar una página compilada

Una página de una compilación tal como la leería un visitante, para un agente sin navegador: título, descripción, encabezados, enlaces, texto visible e issues que detectaría una revisión rápida (falta de h1, imágenes sin alt, texto de marcador de posición). Valor predeterminado: la página de inicio de la compilación lista más reciente del borrador. Si tienes un navegador, getSiteBuild con preview=true proporciona un enlace para verla.

GET/v1/sites/{site_id}/pages

Request

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

import json
import requests

url = "https://api.atelier201.com/v1/sites/<site_id>/pages"
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>/pages", {
  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>/pages");
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>/pages", 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>/pages"))
    .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>/pages")
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": {
    "build_id": "<string>",
    "revision": "<string>",
    "path": "<string>",
    "status": 123,
    "location": "<string>",
    "pages": [
      "<string>"
    ],
    "title": null,
    "description": null,
    "lang": null,
    "headings": [
      {
        "level": 123,
        "text": "<string>"
      }
    ],
    "links": [
      {
        "href": "<string>",
        "text": "<string>"
      }
    ],
    "images_without_alt": [
      "<string>"
    ],
    "og_image": null,
    "structured_data": [
      "<string>"
    ],
    "broken_targets": [
      "<string>"
    ],
    "text": "<string>",
    "text_truncated": true,
    "issues": [
      "<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.

Devuelve el título, la descripción, los encabezados, los enlaces y el texto visible de la página; las demás pages de la compilación; y los issues que detectaría una revisión rápida: ausencia de <title> o h1, varios h1, imágenes sin alt, enlaces sin texto o texto de marcador de posición. Valor predeterminado: / de la compilación lista más reciente del borrador.

Si tienes un navegador, Recuperar una compilación con preview=true devuelve un enlace privado para ver la página.

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

pathstringlength: ≤ 600 chars

La página, tal como la escribiría un visitante: / o /about. Valor predeterminado: /.

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

Una compilación. Valor predeterminado: la compilación lista más reciente del borrador (la que muestra la vista previa).

Respuesta

application/json

Leer una página compilada

dataobjectrequired

Show child attributes

data.build_idstringrequired

data.revisionstringrequiredlength: 40–40 chars

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

data.pathstringrequired

data.statusintegerrequiredrange: -9007199254740991–9007199254740991

200, 404 (la página de error 404 del sitio, si existe) o el código de estado de una redirección.

data.locationstring

Destino de una redirección.

data.pagesstring[]required

Todas las páginas de la compilación, para poder leer las demás.

data.titlestringnull

data.descriptionstringnull

data.langstringnull

data.headingsobject[]

Show child attributes

data.headings.levelintegerrequiredrange: -9007199254740991–9007199254740991

data.headings.textstringrequired

data.linksobject[]

Show child attributes

data.links.hrefstringrequired

data.links.textstringrequired

data.images_without_altstring[]

data.og_imagestringnull

La imagen que muestra un enlace compartido a la página (og:image), o null.

data.structured_datastring[]

Los tipos de schema.org que declara la página en JSON-LD (LocalBusiness, Article...).

data.broken_targetsstring[]

Enlaces internos y archivos (imágenes, hojas de estilo y scripts) que usa la página y que no están disponibles en la compilación.

data.textstring

Texto visible del contenido principal de la página, con un máximo de 20,000 caracteres.

data.text_truncatedboolean

data.issuesstring[]

Lo que detectaría una revisión rápida: falta de título o h1, varios h1, imágenes sin alt, enlaces sin texto, texto de marcador de posición.

request_idstringrequired

{ "data": { "build_id": "<string>", "revision": "<string>", "path": "<string>", "status": 123, "location": "<string>", "pages": [ "<string>" ], "title": null, "description": null, "lang": null, "headings": [ { "level": 123, "text": "<string>" } ], "links": [ { "href": "<string>", "text": "<string>" } ], "images_without_alt": [ "<string>" ], "og_image": null, "structured_data": [ "<string>" ], "broken_targets": [ "<string>" ], "text": "<string>", "text_truncated": true, "issues": [ "<string>" ] }, "request_id": "<string>" }

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

Consultar una página compilada

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