Понятно человеку
Просматривайте endpoints, поля, примеры, ошибки и ответы без чтения серверного кода.
OPENAPI 3.0 · ПРОДАКШЕН API
Справочник URLZ OpenAPI
Все поддерживаемые операции URLZ API, параметры, ответы и способы авторизации в одном понятном машиночитаемом справочнике.
OPENAPI
Надёжный контракт для каждой интеграции
Описание OpenAPI — технический контракт между URLZ и вашим приложением. Оно помогает понять запросы, проверить ответы, импортировать API или сгенерировать клиент.
Понятно инструментам
Импортируйте JSON в Postman, Insomnia, Swagger, Redocly или генератор клиентов.
Безопасно по умолчанию
Для каждой операции указана авторизация. Секреты должны храниться на сервере.
QUICK START
Начните за четыре шага
- 1
Создайте аккаунт
Создайте аккаунт URLZ и откройте раздел API в dashboard.
- 2
Выберите авторизацию
API-ключ для сервера или Bearer-сессия для функций аккаунта.
- 3
Отправьте запрос
Скопируйте пример, замените значения и отправьте через HTTPS.
- 4
Обработайте ответ
Сначала проверьте HTTP-статус, затем JSON-ответ.
API REFERENCE
Полный интерактивный справочник
Ищите в спецификации и открывайте операции с параметрами, телом, примерами и ответами.