API
¿Que es esto?
Es la documentación necesaria para que los desarrolladores puedan explotar las posibilidades que ofrece cryptimg para poder crear mashupsEncriptar mensajes en imagenes
Descripción:Genera una imagen al vuelo con el mensaje encriptado
Formato URL:
http://www.viciao2k3.net/services/cryptimg/api/v1/?url=URL&pass=PASS&msg=MENSAJE
Parametros de entrada GET:
| nombre | obligatorio | descripción | observación |
| url | si | url de la imagen | 1. la imagen tiene que existir 2. formatos permitidos: BMP, GIF, JPG, PNG |
| pass | si | clave para encriptar la imagen | |
| msg | si | mensaje a ocultar |
Desencriptar mensajes en imagenes
Descripción:Desencripta el mensaje de imagen a traves de una clave
Formato URL:
http://www.viciao2k3.net/services/cryptimg/api/ v1/?url=URL&pass=PASS[&format=FORMATO&callback=CALLBACK]
Parametros de entrada GET:
| nombre | obligatorio | descripción | observación |
| url | si | url de la imagen | 1. la imagen tiene que existir 2. formatos permitidos: BMP, GIF, JPG, PNG |
| pass | si | clave para desencriptar la imagen | |
| format | no | formato para devolver los resultados: - xml - json - txt (texto plano) | si no se indica el parametro format, se devuelve por defecto los resultados en xml |
| callback | no | solo formato json | función javascript de retorno |
Ejemplos de respuesta al desencriptar
Parametros respuesta:| nombre | descripción |
| url | url de la imagen |
| msg | mensaje desencriptado |
Diferentes formatos de resultados según el parametro "format":
| XML |
|
Formato URL: http://www.viciao2k3.net/services/cryptimg/api/v1/?url=http://www.viciao2k3.net/ services/cryptimg/api.jpg&pass=BETA&format=XML Resultado: <?xml version="1.0" encoding="utf-8"?> <data> <url>http://www.viciao2k3.net/services/cryptimg/api.jpg</url> <msg>esto es una prueba</msg> </data> |
| JSON |
|
Formato URL: http://www.viciao2k3.net/services/cryptimg/api/v1/?url=http://www.viciao2k3.net/ services/cryptimg/api.jpg&pass=BETA&format=JSON Resultado:
{
"url":"http:\/\/www.viciao2k3.net\/services\/cryptimg\/api.jpg",
"msg":"esto es una prueba"
}
|
| JSON + CALLBACK |
|
Formato URL: http://www.viciao2k3.net/services/cryptimg/api/v1/?url=http://www.viciao2k3.net/ services/cryptimg/api.jpg&pass=BETA&format=JSON&callback=ejecutar_funcion_js Resultado:
ejecutar_funcion_js(
{
"url":"http:\/\/www.viciao2k3.net\/services\/cryptimg\/img\/api.jpg",
"msg":"esto es una prueba"
}
);
|
| TXT |
|
Formato URL: http://www.viciao2k3.net/services/cryptimg/api/v1/?url=http://www.viciao2k3.net/ services/cryptimg/api.jpg&pass=BETA&format=TXT Resultado: esto es una prueba |
Errores
Parametros respuesta:| nombre | descripción |
| url | url de la imagen |
| error | código del error |
| msg | descripción del error |
Descripción errores:
| código | descripción | solución |
| 400 | Formato de fichero no valido | la imagen tiene que ser uno de los formatos: BMP, GIF, JPG, PNG |
| 401 | Clave para descodificar incorrecta | introducir la clave buena |
| 403 | Falta pasar el parametro clave | introducir la clave buena |
| 404 | Imagen no valida | la imagen no puede estar vacia y tiene que ser uno de los formatos: BMP, GIF, JPG, PNG |
Ejemplos para descargar
- Encriptar imagen- Desencriptar imagen con JSON + CALLBACK