API знімків потрібен, коли продукту, процесу розгортання або роботі з вмістом потрібна відображена сторінка, а не власний браузерний процес для підтримки. Це може бути знімок для запису випуску, PDF для документа, HTML або Markdown для процесу з вмістом чи збережений файл для подальшого перегляду.
RenderLog трактує такий запит як запуск із результатом та історією. Використовуйте короткий GET для простого URL. Використовуйте POST, коли потрібні заголовки, cookies, кроки, перевірки або мітки. Разовий API-запит зберігає артефакт у стандартному сховищі RenderLog. Якщо конфігурація повторюється й потребує іншого призначення, збережіть її як перевірку робочого простору.
Оберіть форму запиту відповідно до сторінки
GET підходить для простого знімка URL, який відображається з публічними налаштуваннями. Це малий перший крок для разового результату. POST дає місце описати справжню роботу, коли сторінці потрібен додатковий контекст або повторювана конфігурація.
Різниця полягає в обсязі налаштувань, а не в окремому продукті. Обидва шляхи створюють запуск, який можна переглянути та пов'язати з подальшою роботою. Починайте з найменшого правдивого запиту й додавайте лише потрібні засоби для отримання та перевірки стану.
- Використовуйте GET для публічного URL і простого запиту файлу
- Використовуйте POST для заголовків, cookies, кроків або перевірок
- Додавайте мітку, щоб рецензент бачив продукт або випуск
- Збережіть перевірку робочого простору, якщо потрібне інше призначення файлів
- Тримайте повні токени та приватні значення поза URL і спільними результатами
Запитуйте файл, який може використати ваш процес
Знімок - лише один із корисних результатів. RenderLog може створювати знімки, PDF, HTML, Markdown і збережені файли з тією самою моделлю відображення, яку використовують збережені перевірки сторінок. Робочий простір лишається місцем перегляду, а процес отримує потрібний файл.
Оберіть область перегляду та налаштування, що описують потрібну аудиторію чи документ. Разові API-запуски зберігають артефакт у стандартному сховищі RenderLog. Збережена перевірка робочого простору може використовувати налаштоване призначення, якщо наступному кроку потрібен інший файл.
- Використовуйте знімки для доказів випуску, перегляду макета та записів сторінки
- Використовуйте PDF, HTML або Markdown для процесів із документами чи вмістом
- Використовуйте збережену перевірку, якщо процес потребує іншого призначення
- Давайте результатам назви, зрозумілі людині в історії запусків
Додавайте перевірки, коли самого файлу недостатньо
Успішна відповідь не обов'язково означає, що відображено правильну сторінку. Екран авторизації, відсутній селектор або змінений вміст також можуть дати справне зображення. Додавайте перевірки й правила помилки, коли очікуються заголовок, елемент, значення поля чи позначений стан.
Якщо знімок потрібно переглядати регулярно, збережіть налаштування як набір перевірок. Наступні запуски можуть порівнювати результат із погодженим еталоном і зберігати рішення в історії. API лишається способом запуску, а робочий простір дає місце для доказів.
- Перевіряйте стан сторінки, через який результат має цінність
- Позначайте неправильне відображення як помилку, а не як успішний файл
- Зберігайте повторювані запити як перевірки з еталоном, якщо це доречно
- Переглядайте файл поруч із перевірками та станом запуску
Знайте межі API-відображення
API відображає стан, описаний запитом на момент запуску. Воно не робить сторонні сервіси стабільними, не скасовує потребу захищати облікові дані та не гарантує однаковий вигляд для всіх відвідувачів. Cookies, заголовки, стани згоди й сторонній вміст треба сприймати як частину потрібного стану та перевіряти.
Зберігайте токени з необхідними дозволами й приховуйте їх у налаштуваннях робочого простору. Не додавайте повні ключі до публічного URL, знімка чи спільного журналу. Якщо процес потребує рішення, тримайте файл і результат перевірки разом, щоб його можна було пов'язати із запитом та історією.
Поєднайте API-вивід із процесом продукту
Переглянути посібники RenderLog
Відкрийте практичні посібники про no-code перевірки, візуальний перегляд і API.
Посібник: як отримувати знімки сайту через API
Оберіть форму запиту та файл відповідно до справжнього процесу сторінки.
Моніторинг змін на сайті
Використовуйте повторювані перевірки, коли результат треба переглядати після наступних змін.
No-code перевірки сайтів
Додавайте перевірки станів і вмісту без підтримки браузерного набору.
Посібник: коли GET, а коли POST
Виберіть форму API-запиту відповідно до налаштувань справжнього завдання.
Посібник: ручні знімки для перевірки випуску
Починайте з візуальної відповіді та зберігайте налаштування, якщо перевірка повторюється.
Документація API RenderLog
Перегляньте публічні запити, запуски та файли перед інтеграцією.
Почніть із найменшого корисного запиту
Отримайте потрібний файл, перегляньте запуск і додавайте налаштування чи перевірки лише за потреби. Збережіть його як перевірку, коли сторінку потрібно регулярно переглядати.