Получить снимок страницы

GET /api/v1/sites/{site}/artifacts/{uuid}

Возвращает содержимое снимка или изображения по UUID. Проверяет принадлежность артефакта сайту.

Доступ

Bearer API-ключ своего пространства, в том числе ключ только на чтение. Дополнительно проверяются права владельца на ресурс и действие. Для чужого объекта доступ не предоставляется.

Параметры

Параметры пути: site, uuid. Подставьте идентификаторы из ответов своей установки.

Тело запроса не требуется.

Ответ не JSON. Content-Type зависит от артефакта. Сохраните байты в файл. Если содержимое уже очищено, ответ 410. Не исполняйте скачанный HTML в доверенном контексте своего приложения.

Ответ 200

Тело ответа содержит байты файла. Формат указан в Content-Type. Примеры ниже сохраняют ответ в result.bin.

Как отправить запрос

В серверном окружении задайте BASE (адрес установки без завершающего слеша) и API_KEY. Секрет не вставляется в исходник. Подготовка клиентов и браузерный JavaScript.

curl

curl --fail-with-body -X GET "$BASE/api/v1/sites/1/artifacts/11111111-1111-4111-8111-111111111111" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Accept: application/json" \
  --output result.bin

Node.js · сервер

// Node.js, сервер. Сохраните как request.mjs.
import { writeFile } from "node:fs/promises";
const response = await fetch(process.env.BASE + "/api/v1/sites/1/artifacts/11111111-1111-4111-8111-111111111111", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.API_KEY}`,
    Accept: "application/json"
  },
  signal: AbortSignal.timeout(120000)
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
await writeFile("result.bin", Buffer.from(await response.arrayBuffer()));

Python

import json
import os
import urllib.request
import urllib.error

request = urllib.request.Request(
    os.environ["BASE"] + "/api/v1/sites/1/artifacts/11111111-1111-4111-8111-111111111111",
    method="GET",
    headers={"Authorization": "Bearer " + os.environ["API_KEY"],
             "Accept": "application/json"},
)
try:
    with urllib.request.urlopen(request, timeout=120) as response:
        with open("result.bin", "wb") as target:
            target.write(response.read())
except urllib.error.HTTPError as error:
    print(error.code, error.read().decode("utf-8", errors="replace"))
    raise

PHP · внешний клиент

<?php
$handle = curl_init(getenv("BASE") . "/api/v1/sites/1/artifacts/11111111-1111-4111-8111-111111111111");
curl_setopt_array($handle, [
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 120,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("API_KEY"),
        "Accept: application/json",
    ],
]);
$content = curl_exec($handle);
$status = curl_getinfo($handle, CURLINFO_RESPONSE_CODE);
if ($content === false) {
    throw new RuntimeException(curl_error($handle));
}
curl_close($handle);
if ($status < 200 || $status >= 300) {
    throw new RuntimeException("HTTP $status: $content");
}
file_put_contents("result.bin", $content);

Go

package main

import (
    "fmt"
    "io"
    "net/http"
    "os"
    "time"
)

func main() {
    request, err := http.NewRequest("GET", os.Getenv("BASE") + "/api/v1/sites/1/artifacts/11111111-1111-4111-8111-111111111111", nil)
    if err != nil { panic(err) }
    request.Header.Set("Authorization", "Bearer " + os.Getenv("API_KEY"))
    request.Header.Set("Accept", "application/json")
    client := &http.Client{Timeout: 120 * time.Second}
    response, err := client.Do(request)
    if err != nil { panic(err) }
    defer response.Body.Close()
    content, err := io.ReadAll(response.Body)
    if err != nil { panic(err) }
    if response.StatusCode < 200 || response.StatusCode >= 300 {
        panic(fmt.Sprintf("HTTP %d: %s", response.StatusCode, content))
    }
    if err := os.WriteFile("result.bin", content, 0600); err != nil { panic(err) }
}

Если запрос не выполнен

401: проверьте ключ и срок. 403: права, режим чтения/записи и 2FA. 404: идентификатор и пространство. 422: поля запроса или состояние объекта. 429: подождите Retry-After. Подробно об ошибках и повторах.