Update page 'API de Tupale'
parent
11246a2b03
commit
209218e409
109
API de Tupale.md
Normal file
109
API de Tupale.md
Normal file
@ -0,0 +1,109 @@
|
|||||||
|
Una API (siglas de ‘Application Programming Interface’) es un conjunto de reglas (código) y especificaciones que las aplicaciones pueden seguir para comunicarse entre ellas: sirviendo de interfaz entre programas diferentes de la misma manera en que la interfaz de usuario facilita la interacción humano-software.
|
||||||
|
|
||||||
|
El principal activo de Tupale.co es su API, todos los datos ingresados a la plataforma en cualquiera de su naturaleza se convierten en una API Json un formato popular que permite la consulta y uso de los datos.
|
||||||
|
|
||||||
|
# API de Tupale.co
|
||||||
|
|
||||||
|
La API consulta todos los datos si se ha logueado en el
|
||||||
|
sistema a nivel remoto para datos privados, o sin logueo para los datos de los formularios que
|
||||||
|
se han marcado como de contenido público.
|
||||||
|
|
||||||
|
https://tupale.co//milfs/api.php
|
||||||
|
Consulta cuales formularios hay en la instancia.
|
||||||
|
|
||||||
|
http://localhost/milfs/api.php?id=3
|
||||||
|
Consulta todo el contenido que se ha introducido en un formulario
|
||||||
|
pasándo el id como parámetro.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Consulta todos los datos que se han llenado en cada formulario pasando
|
||||||
|
el identificador como parámetro, cabe anotar que cuando se edita un
|
||||||
|
formulario se guarda la versión anterior de este campo por lo que si
|
||||||
|
se quiere conocer el estado actual de un formulario que ha sido
|
||||||
|
editado, debería filtrarse por timestamp para conocer su ultima
|
||||||
|
versión o versiones anteriores.
|
||||||
|
|
||||||
|
|
||||||
|
https://tupale.co/milfs/api.php?dato=52772
|
||||||
|
Consulta la info sobre un dato en concreto pasando el id del dato
|
||||||
|
como parametro.
|
||||||
|
|
||||||
|
Para entender el manejo de la api se debe tener en cuenta lo siguiente:
|
||||||
|
|
||||||
|
Cuando se crea un formulario MILFS le asigna un ID único a cada formulario que aparece en el JSON como: "form_id": pero esto solo es útil si se quiere hacer referencia al formulario específico llamando la API sin ningún parámetro, así:
|
||||||
|
|
||||||
|
https://tupale.co/milfs/api.php
|
||||||
|
|
||||||
|
Si se quiere leer los datos en un formulario especifico, la api se llama de la siguiente forma:
|
||||||
|
|
||||||
|
https://tupale.co/milfs/api.php?id=19
|
||||||
|
|
||||||
|
De esta forma la API nos entrega todos los datos, para hacer ejercicios de visualización de datos lo recomendable es utilizar los ID de los campos, especificado en el JSON así: "id_campo"
|
||||||
|
Cada campo asociado a un formulario se le asigna un ID único.
|
||||||
|
|
||||||
|
# Manejo de Imágenes
|
||||||
|
|
||||||
|
Milf permite almacenar imágenes para los formularios, las imágenes quedan almacenadas en el sistema de archivos del servidor, y genera de forma automática 3 tamaños (150px 300px y 600px) igualmente almacena la imagen en el tamaño original.
|
||||||
|
|
||||||
|
Lo siguiente es un ejemplo de como la **API** entrega un dato tipo **IMAGEN**:
|
||||||
|
~~~
|
||||||
|
|
||||||
|
{
|
||||||
|
"0": 53326,
|
||||||
|
"id_dato": 53326,
|
||||||
|
"1": 21,
|
||||||
|
"id_formulario": 21,
|
||||||
|
"2": "Viaje a pie",
|
||||||
|
"formulario": "Viaje a pie",
|
||||||
|
"3": "imagen",
|
||||||
|
"campo_nombre": "imagen",
|
||||||
|
"4": 0,
|
||||||
|
"id_campo": 0,
|
||||||
|
"5": "7b2deb5cb4580984c8acd71c09e0f1f1.jpg",
|
||||||
|
"contenido": "7b2deb5cb4580984c8acd71c09e0f1f1.jpg",
|
||||||
|
"6": 1432608321,
|
||||||
|
"timestamp": 1432608321,
|
||||||
|
"7": "4b0d9a636567465bed3ada5a2e6f2fa6",
|
||||||
|
"identificador": "4b0d9a636567465bed3ada5a2e6f2fa6",
|
||||||
|
"8": 0,
|
||||||
|
"orden": 0
|
||||||
|
},
|
||||||
|
|
||||||
|
~~~
|
||||||
|
|
||||||
|
Ahora para usar la imagen se debe completar la URL, como se ve en los siguientes ejemplos:
|
||||||
|
|
||||||
|
**Para usar la imagen de 600px**
|
||||||
|
|
||||||
|
https://tupale.co/milfs/images/secure/?file=600/7b2deb5cb4580984c8acd71c09e0f1f1.jpg
|
||||||
|
|
||||||
|
**Para usar la imagen de 300px**
|
||||||
|
|
||||||
|
https://tupale.co/milfs/images/secure/?file=300/7b2deb5cb4580984c8acd71c09e0f1f1.jpg
|
||||||
|
|
||||||
|
**Para usar la imagen de 150px**
|
||||||
|
|
||||||
|
https://tupale.co/milfs/images/secure/?file=150/7b2deb5cb4580984c8acd71c09e0f1f1.jpg
|
||||||
|
|
||||||
|
**Para usar la imagen FULL o Original**
|
||||||
|
|
||||||
|
https://tupale.co/milfs/images/secure/?file=full/7b2deb5cb4580984c8acd71c09e0f1f1.jpg
|
||||||
|
|
||||||
|
**Nota:** Es importante que observe que el JSON entrega el dato de la siguiente forma:
|
||||||
|
~~~
|
||||||
|
"5": "7b2deb5cb4580984c8acd71c09e0f1f1.jpg",
|
||||||
|
~~~
|
||||||
|
|
||||||
|
Cada imagen queda codificada de la siguiente forma: 7b2deb5cb4580984c8acd71c09e0f1f1.jpg que será el nombre de la imagen asignada por el sistema.
|
||||||
|
|
||||||
|
## API Simple
|
||||||
|
|
||||||
|
La API simple es una consulta que genera una api tipo clave / valor. Se utiliza agregando al final de cada dirección de acceso a una API el parámetro: &tipo=simple
|
||||||
|
|
||||||
|
**Ejemplo:**
|
||||||
|
https://tupale.co/milfs/api.php?id=6&tipo=simple
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Loading…
Reference in New Issue
Block a user