Com funciona l’API del ja.cat
Com activar l’accés a l’API del ja.cat i quines accions pots executar per automatitzar la creació i la gestió dels teus enllaços curts.
L’API del ja.cat et permet integrar l’eina directament a la teva aplicació o automatitzar la creació i gestió d’enllaços sense accedir al panell de control. En aquesta guia t’expliquem com activar l’accés a l’API i quines accions pots executar.
El pas per pas per començar a utilitzar l’API
1. Accedeix al teu compte del ja.cat.
2. Ves al teu panell de control i localitza l’apartat API.
Activa l’accés i el sistema et generarà automàticament una clau d’accés: una contrasenya de 64 caràcters alfanumèrics que només tu coneixes. La pots regenerar quan vulguis.
3. Fes clic a «Consulta la documentació pública de l’API» per veure totes les accions disponibles i com executar-les.
4. Per utilitzar l’API, cada petició que enviïs al servidor ha d’incloure la teva clau d’accés.
Això permet al sistema verificar que ets tu qui fa la sol·licitud. En cas d’automatitzar-ho, pots afegir una funcionalitat que t’afegeixi la contrasenya automàticament; d’aquesta manera tindrà la contrasenya a totes les peticions que facis.
5. A la secció «Referència ràpida» trobaràs el resum de totes les accions que pots fer.
I a l’apartat «Funcions» hi ha les instruccions concretes per executar cada acció.
Què pots fer amb l’API?
- Fer un llistat de tots els teus enllaços (GET /urls): aquesta funció serveix per a obtenir els identificadors dels teus enllaços, i no cal definir-hi cap paràmetre especial.
- Crear un nou enllaç curt (POST /url): aquesta crida utilitza dos paràmetres. Cal indicar l’enllaç llarg (la pàgina de destí) i l’enllaç curt que anirà després de ja.cat/.
- Modificar la URL llarga d’un enllaç existent (PUT /url): necessites l’identificador de l’enllaç que vols modificar, i l’has d’especificar a la URL de la crida. Si vols modificar l’enllaç amb identificador 1043 la URL de la crida serà https://servei.ja.cat/url/1043. La crida utilitza dos paràmetres: l’enllaç llarg (la nova pàgina de destí) i si vols que l’enllaç estigui actiu o no.
- Eliminar un enllaç (DELETE /url): amb aquesta petició no cal cap paràmetre. Només cal indicar l’identificador de l’enllaç a esborrar a la URL de la petició. Si vols esborrar l’enllaç 1042, caldrà posar https://servei.ja.cat/url/1042.
- Habilitar o deshabilitar un enllaç (PUT /estat): amb aquesta petició no cal cap paràmetre. Només cal indicar l’identificador de l’enllaç a modificar. Si es vol modificar el 1041, caldrà posar https://servei.ja.cat/estat/1041.
- Comprovar si el nom d’un enllaç està disponible (GET /disponibilitat): amb aquesta petició no cal cap paràmetre. Només cal indicar l’enllaç curt a cercar al final de la URL, després de /disponibilitat. Per exemple: https://servei.ja.cat/disponibilitat/20anysdomini.
Recorda que trobaràs tota aquesta informació a la Documentació de l’API pública de ja.cat, accessible des de l’apartat API del teu panell de control del ja.cat.
