Cómo funciona la API de ja.cat
Cómo activar el acceso a la API de ja.cat y qué acciones puedes ejecutar para automatizar la creación y la gestión de tus enlaces cortos.
La API de ja.cat te permite integrar la herramienta directamente en tu aplicación o automatizar la creación y gestión de enlaces sin acceder al panel de control. En esta guía te explicamos cómo activar el acceso a la API y qué acciones puedes ejecutar.
Paso a paso para empezar a usar la API
1. Accede a tu cuenta de ja.cat.
2. Ve a tu panel de control y localiza el apartado API.
Activa el acceso y el sistema te generará automáticamente una clave de acceso: una contraseña de 64 caracteres alfanuméricos que solo tú conoces. Puedes regenerarla cuando quieras.
3. Haz clic en «Consulta la documentació pública de l’API» para ver todas las acciones disponibles y cómo ejecutarlas.
4. Para usar la API, cada petición que envíes al servidor debe incluir tu clave de acceso.
Esto permite al sistema verificar que eres tú quien hace la solicitud. Si lo automatizas, puedes añadir una funcionalidad que incluya la contraseña automáticamente en todas las peticiones.
5. En la sección «Referència ràpida» encontrarás el resumen de todas las acciones disponibles.
Y en el apartado «Funcions» están las instrucciones concretas para ejecutar cada acción.
¿Qué puedes hacer con la API?
- Listar todos tus enlaces (GET /urls): esta función sirve para obtener los identificadores de tus enlaces. No hace falta definir ningún parámetro especial.
- Crear un nuevo enlace corto (POST /url): esta llamada utiliza dos parámetros. Hay que indicar el enlace largo (la página de destino) y el enlace corto que irá después de ja.cat/.
- Modificar la URL larga de un enlace existente (PUT /url): necesitas el identificador del enlace que quieres modificar y debes especificarlo en la URL de la llamada. Si quieres modificar el enlace con identificador 1043, la URL de la llamada será https://servei.ja.cat/url/1043. La llamada utiliza dos parámetros: el enlace largo (la nueva página de destino) y si quieres que el enlace esté activo o no.
- Eliminar un enlace (DELETE /url): con esta petición no hace falta ningún parámetro. Solo hay que indicar el identificador del enlace a borrar en la URL de la petición. Si quieres borrar el enlace 1042: https://servei.ja.cat/url/1042.
- Habilitar o deshabilitar un enlace (PUT /estat): con esta petición no hace falta ningún parámetro. Solo hay que indicar el identificador del enlace a modificar. Si quieres modificar el enlace 1041: https://servei.ja.cat/estat/1041.
- Comprobar si el nombre de un enlace está disponible (GET /disponibilitat): con esta petición no hace falta ningún parámetro. Solo hay que indicar el enlace corto al final de la URL, después de /disponibilitat. Por ejemplo: https://servei.ja.cat/disponibilitat/20anysdomini.
Recuerda que encontrarás toda esta información en la Documentación de la API pública de ja.cat, accesible desde el apartado API de tu panel de control.
