Hoppa till huvudinnehåll
Detta dokument kommer att introducera en integrationsbeskrivning för Kort URL API, som kan konvertera längre URL:er till kortare URL:er.

​
Ansökningsprocess

För att använda API:et måste du först gå till Kort URL API motsvarande sida för att ansöka om den tjänst som behövs. När du kommer till sidan, klicka på knappen “Acquire”, som visas i bilden nedan: Om du inte har loggat in eller registrerat dig kommer du automatiskt att omdirigeras till inloggningssidan där du uppmanas att registrera dig och logga in. Efter att ha loggat in eller registrerat dig kommer du automatiskt att återvända till den aktuella sidan. Vid första ansökan kommer det att finnas en gratis kvot som ges, så att du kan använda API:et gratis.

​
Grundläggande användning

Först bör du förstå den grundläggande användningsmetoden, vilket innebär att du anger den längre URL som behöver konverteras för att få det bearbetade resultatet. Du behöver först enkelt överföra ett content-fält. Vi kan sedan fylla i motsvarande innehåll på gränssnittet, som visas i bilden nedan:

Här kan vi se att vi har ställt in Request Headers, inklusive:
  • accept: vilken format av svar du vill ta emot, här anges som application/json, det vill säga JSON-format.
  • authorization: nyckeln för att anropa API:et, som kan väljas direkt efter ansökan.
Dessutom har vi ställt in Request Body, inklusive:
  • content: innehållet av URL:en som ska förkortas.
När du har valt kan du se att motsvarande kod också har genererats till höger, som visas i bilden nedan:

Klicka på knappen “Try” för att utföra testet, som visas i bilden ovan, här har vi fått följande resultat: 
{
  "success": true,
  "data": {
    "url": "https://surl.id/1uHCs01xa5"
  }
}
Det returnerade resultatet har flera fält, som beskrivs nedan:
  • success, status för om uppgiften lyckades.
  • data, som innehåller den konverterade URL:en.
Det kan ses att den ursprungliga längre URL:en https://platform.acedata.cloud/documents/a2303356-6672-4eb8-9778-75f55c998fe9 har framgångsrikt konverterats till den korta URL:en https://surl.id/1uHCs01xa5. Om du vill generera motsvarande integrationskod kan du direkt kopiera den som genererats, till exempel CURL-koden nedan: 
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 integrationskoden ser ut som följer: 
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)

​
Felhantering

När du anropar API:et, om du stöter på fel, kommer API:et att returnera motsvarande felkod och information. Till exempel:
  • 400 token_mismatched: Bad request, möjligtvis på grund av saknade eller ogiltiga parametrar.
  • 400 api_not_implemented: Bad request, möjligtvis på grund av saknade eller ogiltiga parametrar.
  • 401 invalid_token: Unauthorized, ogiltig eller saknad auktoriseringstoken.
  • 429 too_many_requests: För många förfrågningar, du har överskridit hastighetsgränsen.
  • 500 api_error: Intern serverfel, något gick fel på servern.

​
Exempel på felrespons

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

​
Slutsats

Genom detta dokument har du fått en förståelse för hur du använder Kort URL API för att konvertera längre URL:er till kortare URL:er. Vi hoppas att detta dokument kan hjälpa dig att bättre integrera och använda API:et. Om du har några frågor, tveka inte att kontakta vårt tekniska supportteam.