Nombre
Eliminar un enlace corto
El enlace deja de redirigir y desaparece de la API. Su código queda ocupado, y lo puedes restaurar durante 90 días.
Método HTTP y ruta
/https:
Qué pasa al ejecutarlo
- Elimina datos de tu organización.
- La llamada no se cobra.
Qué hace
Borrado lógico: el enlace deja de redirigir de inmediato (el visitante recibe 404) y desaparece de todas las respuestas de la API, estadísticas incluidas. Lo cobrado se conserva, y queda registrado quién lo eliminó. Su código queda ocupado para siempre en ese dominio: nadie puede crear otro enlace con él, pero tú puedes restaurar este, sin nuevo cobro, durante 90 días. Después el enlace se archiva con sus visitas y ya no se puede restaurar; el código sigue ocupado.
Un enlace bloqueado por Hablame (status:) no se puede eliminar: responde 409 LINK_BLOCKED.
Disponibilidad y requisitos previos
- Publicado y disponible en la API v6 de producción.
- Todas las rutas parten de
https:./ / developers. hablame. co - Necesitas una API key de Hablame para llamarlo.
Autenticación y permisos
- Envía tu API key en la cabecera
Authorizationcon el esquema Bearer.
Quién puede llamarlo: Una API key con el servicio urlshortener habilitado.
Límites y consideraciones operativas
Límite de uso: 35 solicitudes por segundo.
Parámetros de ruta
| Nombre | Tipo | Descripción y reglas |
|---|---|---|
domainObligatorio | string | Dominio del enlace, tal como lo devuelve la API en Ejemplo: |
codeObligatorio | string | Código o alias del enlace. Se compara en minúsculas. Ejemplo: |
Parámetros de consulta
| Nombre | Tipo | Descripción y reglas |
|---|---|---|
domainStatusOpcional | string | Con Valores permitidos: |
Encabezados HTTP
| Nombre | Tipo | Descripción y reglas |
|---|---|---|
AuthorizationObligatorio | string | Tu API key con el esquema Bearer. Ejemplo: |
Cuerpo de la petición
Este endpoint no recibe cuerpo en la petición.
Respuestas satisfactorias
204
Enlace eliminado. La respuesta no trae cuerpo.
Esta respuesta no trae cuerpo.
Códigos de error
Todas las respuestas de error tienen la misma forma: success en false y un objeto error cuyo code dice qué pasó. Aquí están agrupadas por tipo, con los códigos que este endpoint puede devolver.
Forma de una respuesta de error
| Nombre | Tipo | Descripción y reglas |
|---|---|---|
successSiempre presente | boolean | Valor fijo: |
metaSiempre presente | object | Metadatos de la respuesta. |
meta.Siempre presente | string | Identificador único de la solicitud (16 caracteres hexadecimales). Es el mismo de la cabecera Ejemplo: |
meta.Siempre presente | string | IP con la que la API vio tu solicitud. Útil si tu API key solo admite ciertas redes. Ejemplo: |
meta.Siempre presente | string | Fecha y hora en que se construyó la respuesta (ISO 8601 con offset). Formato: |
meta.Siempre presente | number | Tiempo (ms) que tomó procesar la solicitud en el servidor. Ejemplo: |
errorSiempre presente | object | |
error.Siempre presente | string | Identificador estable en UPPER_SNAKE_CASE. Los clientes ramifican sobre este valor. Ejemplo: |
error. | integer | Código numérico legacy v5, solo cuando hay puente. Se omite en los códigos nacidos en v6. Ejemplo: |
error.Siempre presente | string | URL a la documentación del error. Formato: |
error.Siempre presente | string | Texto legible en inglés. Es para el log del desarrollador, no para el usuario final: no lo parsees. |
error.Siempre presente | array<object> | Contexto estructurado (validaciones, recurso afectado). Arreglo vacío cuando no hay contexto extra. |
Validación
Este endpoint no declara respuestas de este tipo.
Autenticación
- 401Credenciales inválidas o faltantes.
No se envió un token Bearer y cada llamada lo requiere.
Mensaje que devuelve la API: Authentication is required. Send your API key as `Authorization: Bearer <token>`.
La clave de API no se reconoce: formato equivocado, revocada o vencida.
Mensaje que devuelve la API: The provided API key is invalid or has expired. Please verify the value sent in the `Authorization: Bearer` header.
Permisos
- 403La API key no tiene habilitado el acortador (o está apagado para tu organización), la key no se puede usar desde la red de la petición, o la organización no está activa.
La clave no tiene permitido el servicio detrás de este endpoint.
Mensaje que devuelve la API: This API key is not authorized to use the requested service.
La clave solo funciona desde ciertas redes y tu IP no está entre ellas.
Mensaje que devuelve la API: This API key cannot be used from this IP address. The address we saw is in `meta.clientIp`: call from one of the networks allowed for the key, or use a key that allows this one.
Tu organización está suspendida o cerrada.
Mensaje que devuelve la API: The organization associated with this API key is not active. Please contact support.
Límites de uso
- 429Se excedió el límite de solicitudes.
Excediste el cupo de tu organización para este endpoint.
Mensaje que devuelve la API: You have exceeded the allowed request rate for this endpoint. Please wait before retrying.
Recurso inexistente
- 404No existe un enlace de tu organización con ese dominio y código, o ya estaba eliminado.
No hay un enlace con ese dominio y código.
Mensaje que devuelve la API: No short link was found for that domain and code.
Errores internos y disponibilidad
Este endpoint no declara respuestas de este tipo.
Otras respuestas
- 409El enlace está bloqueado por Hablame.
409LINK_BLOCKED
El enlace está bloqueado por seguridad.
Consideraciones especiales
Una key con el acortador también crea y borra
El servicio urlshortener da todo el acortador: con él, la API key lista y consulta enlaces, y también los crea (cada alta se cobra), los edita, los borra y los restaura. No hay keys de solo lectura. Solo el propietario de tu organización crea las keys: si una no debe crear enlaces, no le des este servicio. Sin él, la key recibe 403 AUTH_SERVICE_NOT_ALLOWED.