Перейти к основному содержанию
В этой статье будет представлена инструкция по интеграции Short URL API, которая позволяет преобразовывать длинные URL в короткие.

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

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

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

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

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

Нажмите кнопку «Try», чтобы провести тестирование, как показано на изображении, и мы получили следующий результат: 
{
  "success": true,
  "data": {
    "url": "https://surl.id/1uHCs01xa5"
  }
}
Возвращаемый результат содержит несколько полей, описание которых приведено ниже:
  • success: статус успешности выполнения задачи.
  • data: содержит преобразованный URL.
Можно увидеть, что изначально длинный URL https://platform.acedata.cloud/documents/a2303356-6672-4eb8-9778-75f55c998fe9 успешно преобразован в короткий URL https://surl.id/1uHCs01xa5. Кроме того, если вы хотите сгенерировать соответствующий код интеграции, вы можете просто скопировать его, например, код CURL выглядит следующим образом: 
curl -X POST 'https://api.acedata.cloud/shorturl' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "content": "https://platform.acedata.cloud/documents/a2303356-6672-4eb8-9778-75f55c998fe9"
}'
Код интеграции на Python выглядит следующим образом: 
import requests

url = "https://api.acedata.cloud/shorturl"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "content": "https://platform.acedata.cloud/documents/a2303356-6672-4eb8-9778-75f55c998fe9"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)

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

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

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

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "fetch failed"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

​
Заключение

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