Saltar al contenido principal
Este documento presentará una descripción de la integración de la API de URL corta, que puede convertir URLs largas en URLs cortas.

Proceso de solicitud

Para usar la API, primero debe ir a la página correspondiente de API de URL corta para solicitar el servicio correspondiente. Una vez en la página, haga clic en el botón “Acquire”, como se muestra en la imagen: Si aún no ha iniciado sesión o registrado, será redirigido automáticamente a la página de inicio de sesión que lo invita a registrarse e iniciar sesión. Después de iniciar sesión o registrarse, volverá automáticamente a la página actual. En la primera solicitud, se le otorgará un límite gratuito que le permitirá usar la API de forma gratuita.

Uso básico

Primero, comprenda la forma básica de uso, que consiste en ingresar la URL larga que necesita convertir, y podrá obtener el resultado procesado. Primero, necesita pasar un campo content. A continuación, podemos completar el contenido correspondiente en la interfaz, como se muestra en la imagen:

Aquí podemos ver que hemos configurado los encabezados de la solicitud, que incluyen:
  • accept: el formato de respuesta que desea recibir, aquí se establece como application/json, es decir, formato JSON.
  • authorization: la clave para llamar a la API, que puede seleccionar directamente después de solicitar.
Además, se ha configurado el cuerpo de la solicitud, que incluye:
  • content: el contenido de la URL que se va a acortar.
Después de seleccionar, se puede observar que también se ha generado el código correspondiente a la derecha, como se muestra en la imagen:

Haga clic en el botón “Try” para realizar la prueba, como se muestra en la imagen anterior, aquí hemos obtenido el siguiente resultado:
{
  "success": true,
  "data": {
    "url": "https://surl.id/1uHCs01xa5"
  }
}
El resultado devuelto tiene varios campos, que se describen a continuación:
  • success, el estado de si la tarea fue exitosa.
  • data, que contiene la URL convertida.
Se puede ver que la URL larga original https://platform.acedata.cloud/documents/a2303356-6672-4eb8-9778-75f55c998fe9 se ha convertido exitosamente en la URL corta https://surl.id/1uHCs01xa5. Además, si desea generar el código de integración correspondiente, puede copiarlo directamente, por ejemplo, el código de CURL es el siguiente:
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"
}'
El código de integración en Python es el siguiente:
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)

Manejo de errores

Al llamar a la API, si encuentra un error, la API devolverá el código de error y la información correspondiente. Por ejemplo:
  • 400 token_mismatched: Solicitud incorrecta, posiblemente debido a parámetros faltantes o inválidos.
  • 400 api_not_implemented: Solicitud incorrecta, posiblemente debido a parámetros faltantes o inválidos.
  • 401 invalid_token: No autorizado, token de autorización inválido o faltante.
  • 429 too_many_requests: Demasiadas solicitudes, ha superado el límite de tasa.
  • 500 api_error: Error interno del servidor, algo salió mal en el servidor.

Ejemplo de respuesta de error

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

Conclusión

A través de este documento, ha aprendido cómo usar la API de URL corta para convertir URLs largas en URLs cortas. Esperamos que este documento le ayude a integrar y utilizar mejor la API. Si tiene alguna pregunta, no dude en ponerse en contacto con nuestro equipo de soporte técnico.