REFERENCIA PARA DESARROLLADORES

Documentación de la API URLZ.li

Autenticación, enlaces cortos, carga de archivos y fotos, estadísticas de clics y API de enlaces de pago con ejemplos listos para usar.

01

Resumen

Crea flujos de enlaces cortos, cargas, estadísticas y acceso de pago con la API de URLZ. Esta referencia separa las integraciones de servidor con clave API de las sesiones de cuenta autenticadas.

Servidor a servidor

Usa la clave API activa para crear y buscar enlaces desde un backend, una automatización o una herramienta interna.

apikey=YOUR_API_KEY

Sesión de cuenta

Usa una sesión Bearer para enlaces, cargas, estadísticas y monetización de la cuenta.

Authorization: Bearer …
02

Inicio rápido

Crea tu primer enlace corto en tres pasos y consulta la referencia detallada para producción.

  1. 1
    Crear una cuenta

    Abre el panel y activa un plan API.

  2. 2
    Copiar la clave API

    Guárdala en tu servidor y no la expongas en código público.

  3. 3
    Enviar la solicitud

    Envía el destino y lee result.short_url en la respuesta JSON.

Curl
curl -X POST "https://api.urlz.li/url/create" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  --data-urlencode "fullUrl=https://example.com/private-report"
03

Autenticación

URLZ admite dos modos de autenticación. Elige el adecuado para tu integración.

A

Clave API

Para integraciones backend. Envía apikey en la URL o el formulario. La clave y la suscripción deben estar activas.

apikey=YOUR_API_KEY
B

Sesión Bearer

Para funciones de cuenta. Obtén un token en el endpoint de acceso y envíalo en Authorization.

Authorization: Bearer SESSION_TOKEN
Mantén las credenciales en el servidor

No publiques claves API, contraseñas ni tokens Bearer en JavaScript, registros móviles, control de versiones o repositorios públicos.

04

Índice de endpoints

Selecciona un endpoint para ver sus parámetros y ejemplos de solicitud y respuesta.

05

Endpoints con clave API

Rutas estables de servidor a servidor para crear y buscar enlaces cortos.

06

Endpoints de cuenta

Enlaces de cuenta, cargas, estadísticas de clics y eliminación.

POST/mobile/v1/auth/login.php

Abrir una sesión de cuenta

Cambia las credenciales por un token de sesión Bearer.

Sin autenticación

Parámetros

ParámetroTipoObligatorioPredeterminado
emailemailSí—
passwordstringSí—
Solicitud
curl -X POST "https://api.urlz.li/mobile/v1/auth/login.php" \
  -H "Content-Type: application/json" \
  -d '{"email":"developer@example.com","password":"YOUR_PASSWORD"}'
Respuesta
{
  "token": "SESSION_TOKEN",
  "user": {
    "id": 42,
    "email": "developer@example.com",
    "apiKey": "ACCOUNT_API_KEY",
    "planActive": true
  }
}
POST/mobile/v1/shorten.php

Crear un enlace de cuenta

Crea un enlace normal o protegido. El token Bearer es opcional salvo si se usa contraseña.

Token Bearer opcional

Parámetros

ParámetroTipoObligatorioPredeterminado
urlURLSí—
passwordstring (min. 4)No—
Solicitud
curl -X POST "https://api.urlz.li/mobile/v1/shorten.php" \
  -H "Authorization: Bearer SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/private","password":"safe-pass"}'
Respuesta
{
  "shortUrl": "https://urlz.li/Ab3dE91x",
  "destination": "https://example.com/private",
  "hash": "Ab3dE91x",
  "protected": true
}
POST/mobile/v1/upload.php

Subir un archivo o foto

Sube un archivo permitido de hasta 10 MB y devuelve una URL corta.

Token Bearer opcional

Parámetros

ParámetroTipoObligatorioPredeterminado
filemultipart fileSí—
kindphoto | documentNodocument
passwordstring (min. 4)No—
Solicitud
curl -X POST "https://api.urlz.li/mobile/v1/upload.php" \
  -H "Authorization: Bearer SESSION_TOKEN" \
  -F "file=@./photo.jpg" \
  -F "kind=photo"
Respuesta
{
  "shortUrl": "https://urlz.li/P8kLm21q",
  "destination": "https://urlz.li/cloud/app/photo_….jpg",
  "hash": "P8kLm21q",
  "protected": false
}
GET/mobile/v1/clicks.php

Consultar estadísticas de clics

Devuelve clics, visitantes únicos, países principales y accesos paginados.

Bearer

Parámetros

ParámetroTipoObligatorioPredeterminado
linkIdintegerSí—
limitinteger (1–100)No100
offsetintegerNo0
Solicitud
curl "https://api.urlz.li/mobile/v1/clicks.php?linkId=1204&limit=25" \
  -H "Authorization: Bearer SESSION_TOKEN"
Respuesta
{
  "link": { "id": 1204, "shortUrl": "https://urlz.li/7b3c2e5a" },
  "summary": {
    "totalClicks": 18,
    "uniqueVisitors": 14,
    "clicksLast24Hours": 2,
    "clicksLast7Days": 9
  },
  "countries": [{ "country": "France", "countryCode": "FR", "clicks": 8 }],
  "items": []
}
07

URLZ Chat & Request

Add private conversations, collect requested documents, schedule reminders and track submissions.

POST/mobile/v1/collaboration/configure.php

Enable URLZ Chat or URLZ Request

Attach a private conversation and/or a document request to an existing account link. A Bearer session token or API key is accepted.

Bearer or API key

Parámetros

ParámetroTipoObligatorioPredeterminado
hashstringSí—
chat.enabledbooleanNofalse
request.enabledbooleanNofalse
request.titlestringNo—
request.itemsstring[]No[]
request.recipientsemail[]No[]
request.deadlineISO datetimeNo—
request.paymentRequiredbooleanNofalse
Solicitud
curl -X POST "https://api.urlz.li/mobile/v1/collaboration/configure.php" \
  -H "Authorization: Bearer SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"hash":"7b3c2e5a","chat":{"enabled":true},"request":{"enabled":true,"title":"Accounting documents","items":["Invoices","Bank statement"]}}'
Respuesta
{"featureId":14,"hash":"7b3c2e5a","chatEnabled":true,"requestEnabled":true}
GET/mobile/v1/collaboration/chats.php

List link conversations

Return chat-enabled links and message totals. Add id to retrieve messages.

Bearer

Parámetros

ParámetroTipoObligatorioPredeterminado
idintegerNo—
afterintegerNo0
Solicitud
curl "https://api.urlz.li/mobile/v1/collaboration/chats.php?id=14" \
  -H "Authorization: Bearer SESSION_TOKEN"
Respuesta
{"items":[{"id":14,"hash":"7b3c2e5a","messageCount":3,"messages":[]}]}
GET/mobile/v1/collaboration/requests.php

Track document requests

List requests, expected items, recipients, submissions and secure files. Add id for full detail.

Bearer

Parámetros

ParámetroTipoObligatorioPredeterminado
idintegerNo—
Solicitud
curl "https://api.urlz.li/mobile/v1/collaboration/requests.php?id=14" \
  -H "Authorization: Bearer SESSION_TOKEN"
Respuesta
{"items":[{"id":14,"title":"Accounting documents","recipients":1,"submissions":1,"files":2}]}
08

Errores y códigos HTTP

Los endpoints modernos devuelven JSON con message; los de clave API usan error. Basa siempre la lógica en el estado HTTP.

{ "message": "A valid link is required." }{ "error": "Invalid API key" }
200
Correcto

La solicitud se completó.

201
Creado

Se creó el enlace o archivo.

400
Solicitud inválida

JSON o sintaxis incorrectos.

401
Autenticación requerida

Falta el token o ha caducado.

403
Prohibido

La clave, el plan o la cuenta no permite la acción.

404
No encontrado

El recurso no existe.

409
Conflicto

El estado solicitado entra en conflicto.

422
Validación fallida

Faltan campos o son inválidos.

429
Demasiadas solicitudes

Reduce el ritmo y reintenta gradualmente.

500/503
Servidor no disponible

Reintenta más tarde de forma idempotente.

09

Seguridad y límites

Aplica estas reglas en toda integración de producción.

  • Usa únicamente HTTPS.
  • Mantén privadas las claves API y renuévalas con regularidad.
  • Valida y codifica los parámetros introducidos por usuarios.
  • Usa paginación en listas y registros.
  • Máximo recomendado: 10 solicitudes por segundo y clave.
¿Necesitas ayuda con una integración?

Envía el endpoint, el estado HTTP y una solicitud depurada. Nunca incluyas credenciales.

URLZ PARA iPHONE

La nueva versión para iOS está casi lista

La actualización de URLZ para iPhone se está finalizando y llegará al App Store en los próximos días. Gracias por tu paciencia.