Home
DEEPSUA API - Documentación¶
Documentación de la API de la Delegación de Estudiantes de la Escuela Politécnica Superior de la Universidad de Alicante.
Una API hace referencia a los procesos, funciones y métodos que brinda una biblioteca de programación a modo de capa de abstracción para que sea empleada por otro programa informático. En nuestro caso, esos otros programas informáticos son los bots de Telegram que se encargan de gestionar los Grados o la Delegación de Estudiantes.
A lo largo de esta página se pueden encontrar los distintos endpoints que ofrece la API, así como su breve descripción y los parámetros que requiere cada uno de ellos. Por otra parte, la documentación de la API se puede encontrar aquí.
Árbol de la web¶
Endpoints¶
Los endpoints de la API son los siguientes:
| Endpoint | Método | Funcionalidad |
|---|---|---|
| / | GET | Devuelve la raíz de la API |
| /grados | GET | Devuelve la información general sobre los grados |
| /grados/lista | GET | Devuelve una lista con los nombres en corto y clave de los grados |
| /grados/{grado} | GET | Devuelve toda la info de un grado |
| /grados/{grado}/calendarios | GET | Devuelve un diccionario con los calendarios de un grado. |
| /grados/{grado}/cursos | GET | Devuelve los cursos de un grado |
| /grados/{grado}/delegados | GET | Devuelve los delegados y las delegadas de un grado |
| /grados/{grado}/materias | GET | Devuelve la lista de materias |
| /grados/{grado}/grupos | GET | Devuelve la lista de grupos de un curso |
| /deepsua | GET | Endpoint genérico de DEEPSUA |
| /deepsua/rrss | GET | Devuelve la lista de RRSS de la Delegación |
| /deepsua/permanente | GET | Devuelve la lista de representantes de la permanente |
| /deepsua/permanente/{grado} | GET | Devuelve información sobre el representante o la representante de un grado |
| /deepsua/comisiones | GET | Devuelve un listado con las comisiones de la Delegación |
| /deepsua/comisiones/{comision} | GET | Devuelve información sobre una comisión |
| /deepsua/comisiones/{comision}/coordinador | GET | Devuelve información sobre el representante o la representante de una comisión |
| /deepsua/comisiones/{comision}/telegram | GET | Devuelve el grupo de Telegram de la comisión |
| /deepsua/comisiones/{comision}/miembros | GET | Devuelve un listado con los miembros de una comisión |
| /deepsua/comisiones/{comision}/miembros | POST | Añade a un usuario o usuaria nueva a una comisión |
Docker¶
La API se puede ejecutar en un contenedor de Docker. Para ello, debemos de seguir los siguientes pasos:
Ahora bien, para ejecutarlo, haremos lo siguiente:
Si queremos detener el contenedor haremos uso del siguiente comando:
Si queremos listar los contenedores activos usaremos: