Przejdź do głównej treści
Niniejszy dokument przedstawia instrukcję integracji z Krótkim URL API, które umożliwia przekształcenie długiego URL w krótki URL.

​
Proces aplikacji

Aby skorzystać z API, należy najpierw przejść do strony Krótkie URL API i złożyć wniosek o odpowiednią usługę. Po wejściu na stronę, kliknij przycisk „Acquire”, jak pokazano na obrazku: Jeśli nie jesteś zalogowany lub zarejestrowany, automatycznie zostaniesz przekierowany na stronę logowania, aby zarejestrować się i zalogować. Po zalogowaniu lub rejestracji automatycznie wrócisz na bieżącą stronę. Podczas pierwszej aplikacji otrzymasz darmowy limit, który pozwala na bezpłatne korzystanie z tego API.

​
Podstawowe użycie

Najpierw zapoznaj się z podstawowym sposobem użycia, polegającym na wprowadzeniu długiego URL, który chcesz przekształcić, aby uzyskać przetworzony wynik. Należy najpierw przekazać prosty parametr content. Następnie możemy wypełnić odpowiednie dane na interfejsie, jak pokazano na obrazku:

Możemy zobaczyć, że ustawiliśmy nagłówki żądania, w tym:
  • accept: w jakim formacie chcesz otrzymać odpowiedź, tutaj wpisano application/json, czyli format JSON.
  • authorization: klucz do wywołania API, po złożeniu wniosku można go bezpośrednio wybrać z rozwijanej listy.
Dodatkowo ustawiono ciało żądania, w tym:
  • content: treść URL, który ma być skrócony.
Po dokonaniu wyboru, można zauważyć, że po prawej stronie wygenerowano odpowiedni kod, jak pokazano na obrazku:

Kliknij przycisk „Try”, aby przeprowadzić test, jak pokazano na powyższym obrazku, tutaj uzyskaliśmy następujący wynik: 
{
  "success": true,
  "data": {
    "url": "https://surl.id/1uHCs01xa5"
  }
}
Wynik zwrotny zawiera wiele pól, które są opisane poniżej:
  • success, status, czy zadanie zakończyło się sukcesem.
  • data, zawiera przekształcony URL.
Można zauważyć, że pierwotny długi URL https://platform.acedata.cloud/documents/a2303356-6672-4eb8-9778-75f55c998fe9 został pomyślnie przekształcony w krótki URL https://surl.id/1uHCs01xa5. Dodatkowo, jeśli chcesz wygenerować odpowiedni kod integracyjny, możesz go bezpośrednio skopiować, na przykład kod CURL wygląda następująco: 
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"
}'
Kod integracyjny w Pythonie wygląda następująco: 
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)

​
Obsługa błędów

Podczas wywoływania API, jeśli napotkasz błąd, API zwróci odpowiedni kod błędu i informacje. Na przykład:
  • 400 token_mismatched: Zły wniosek, prawdopodobnie z powodu brakujących lub nieprawidłowych parametrów.
  • 400 api_not_implemented: Zły wniosek, prawdopodobnie z powodu brakujących lub nieprawidłowych parametrów.
  • 401 invalid_token: Nieautoryzowany, nieprawidłowy lub brakujący token autoryzacyjny.
  • 429 too_many_requests: Zbyt wiele żądań, przekroczono limit.
  • 500 api_error: Błąd wewnętrzny serwera, coś poszło nie tak na serwerze.

​
Przykład odpowiedzi błędu

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

​
Wnioski

Dzięki temu dokumentowi zrozumiałeś, jak używać Krótkiego URL API do przekształcania długich URL w krótkie URL. Mamy nadzieję, że ten dokument pomoże Ci lepiej zintegrować i korzystać z tego API. W przypadku jakichkolwiek pytań, prosimy o kontakt z naszym zespołem wsparcia technicznego.