Get Tools Lab
/
английскийИспанскийФранцузскийНемецкийИтальянскийПортугальскийНидерландыПольскийTürkçeБахаса ИндонезияТианг Вьет日本語한국어中文العربيةहिन्दीবাংলাاردوไทยРусский
Доступ к разработке

Get Tools Lab Разработка API

Интегрируйте опубликованные инструменты, руководства и рабочие процессы платформы, используя проверенные конечные точки разработчиков. Доступные возможности зависят от включенных модулей API и вашего уровня доступа.

Параметры API

Платформа включает в себя конечные точки REST и легкий GraphQL-совместимый уровень с поддержкой ключей API, учетных данных клиента OAuth, аналитики использования, ограничений скорости и доставки подписанного веб-перехватчика. Не все функции общедоступного веб-сайта автоматически доступны через API.

Аутентификация

Конечные точки REST v1 могут использовать ключ API в Заголовок X-API-Key . Новые конечные точки также могут принимать поддерживаемые токены носителя. Храните все учетные данные в секрете и немедленно меняйте ключ, если он станет известен.

curl -H "X-API-Key: qc_your_key" "https://gettoolslab.com/api/v1/tools.php"

Общие конечные точки REST

Инструментs

GET /api/v1/tools.php
GET /api/v1/tools.php?category=PDF
GET /api/v1/tools.php?q=json

Руководствоs

GET /api/v1/guides.php
GET /api/v1/guides.php?q=image

REST v2 и GraphQL

Консолидированная платформа разработчиков может предоставлять новые маршруты REST и операции GraphQL для поддерживаемых ресурсов. Используйте область «Разработка» и игровую площадку API, чтобы увидеть конечные точки, которые фактически включены в текущем развертывании.

Ограничения скорости

Запросы API могут быть ограничены в минуту или в день. Запрос, превышающий лимит, может вернуть HTTP 429 Too Many Requests вместе с информацией о повторной попытке или сбросе. Приложениям следует использовать отсрочку, а не немедленно повторять неудачные запросы.

Вебхуки

Поддерживаемые события могут доставляться в пункт назначения веб-перехватчика HTTPS. Если подпись включена, проверьте подпись HMAC, прежде чем доверять полезной нагрузке. Потребитель веб-перехватчика также должен допускать повторные попытки и должен сделать обработку событий идемпотентной, чтобы одна и та же доставка не создавала повторяющихся действий.

Ошибкаs

Неверные учетные данные, отключенные клиенты, исчерпанные квоты или неверные запросы могут возвращать структурированные ошибки JSON с кодами состояния HTTP 4xx. При сбоях на стороне сервера используются ответы 5xx. Приложения должны регистрировать статус ответа и идентификатор запроса, если он доступен, а не раскрывать секретные учетные данные в отчетах об ошибках.

Безопасность guidance

  • Никогда не встраивайте секретные ключи API в JavaScript общедоступного браузера.
  • Используйте HTTPS для трафика API и веб-перехватчика.
  • Предоставляйте клиентам только те разрешения, которые им необходимы.
  • Проверьте подписи веб-перехватчиков.
  • Замена скомпрометированных учетных данных.
  • Соблюдайте документированные ограничения скорости и размера файла.

SDK и игровая площадка

Посетите раздел «Разработка», чтобы ознакомиться с примерами SDK и интерактивной игровой площадкой. Протестируйте интеграцию с неконфиденциальными данными, прежде чем использовать производственные файлы или информацию о клиентах.