Skip to main content
В этой статье будет представлена инструкция по интеграции Short URL API, которая позволяет преобразовывать длинные URL в короткие.

Процесс подачи заявки

Чтобы использовать API, необходимо сначала перейти на соответствующую страницу Short URL API и подать заявку на соответствующую услугу. После перехода на страницу нажмите кнопку «Acquire», как показано на изображении: Если вы еще не вошли в систему или не зарегистрированы, вас автоматически перенаправит на страницу входа, где вас пригласят зарегистрироваться и войти. После регистрации и входа вы автоматически вернетесь на текущую страницу. При первой подаче заявки будет предоставлен бесплатный лимит, который можно использовать для бесплатного доступа к этому API.

Основное использование

Сначала ознакомьтесь с основным способом использования, который заключается в том, что нужно ввести длинный URL, который необходимо преобразовать, и вы получите обработанный результат. Сначала нужно просто передать поле content. Далее мы можем заполнить соответствующее содержимое на интерфейсе, как показано на изображении:

Как видно, мы настроили заголовки запроса, включая:
  • accept: в каком формате вы хотите получить ответ, здесь указано application/json, то есть в формате JSON.
  • authorization: ключ для вызова API, который можно выбрать из выпадающего списка после подачи заявки.
Также настроено тело запроса, включая:
  • content: содержимое URL, который нужно сократить.
После выбора можно заметить, что справа также сгенерирован соответствующий код, как показано на изображении:

Нажмите кнопку «Try», чтобы провести тестирование, как показано на изображении, и мы получили следующий результат:
Возвращаемый результат содержит несколько полей, описание которых приведено ниже:
  • success: статус успешности выполнения задачи.
  • data: содержит преобразованный URL.
Можно увидеть, что изначально длинный URL https://platform.acedata.cloud/documents/shorturl успешно преобразован в короткий URL https://surl.id/1uHCs01xa5. Кроме того, если вы хотите сгенерировать соответствующий код интеграции, вы можете просто скопировать его, например, код CURL выглядит следующим образом:
Код интеграции на Python выглядит следующим образом:

Обработка ошибок

При вызове API, если возникнет ошибка, API вернет соответствующий код ошибки и информацию. Например:
  • 400 token_mismatched: Неверный запрос, возможно, из-за отсутствия или недействительных параметров.
  • 400 api_not_implemented: Неверный запрос, возможно, из-за отсутствия или недействительных параметров.
  • 401 invalid_token: Неавторизовано, недействительный или отсутствующий токен авторизации.
  • 429 too_many_requests: Слишком много запросов, вы превысили лимит частоты.
  • 500 api_error: Внутренняя ошибка сервера, что-то пошло не так на сервере.

Пример ответа об ошибке

Заключение

С помощью этого документа вы узнали, как использовать Short URL API для преобразования длинных URL в короткие. Надеемся, что этот документ поможет вам лучше интегрировать и использовать этот API. Если у вас есть какие-либо вопросы, пожалуйста, не стесняйтесь обращаться в нашу техническую поддержку.