|
|
La documentación de esta API ofrece una descripción detallada de los
|
|
|
*endpoints* disponibles con ejemplos de las respuestas obtenidas, así como
|
|
|
métodos disponibles con ejemplos de las respuestas obtenidas, así como
|
|
|
información acerca del uso.
|
|
|
|
|
|
Algunas consideraciones previas a tener en cuenta son:
|
... | ... | @@ -12,33 +12,35 @@ Algunas consideraciones previas a tener en cuenta son: |
|
|
- Se pueden considerar todas las respuestas que no sean devueltas con
|
|
|
un código HTTP 200 como un **error**.
|
|
|
|
|
|
- Todas las respuestas son devueltas en **formato JSON** excepto la
|
|
|
autentificación por token que devuelve una cadena de texto plano.
|
|
|
|
|
|
Todas las peticiones que se realicen a la API deben ser enviadas a la
|
|
|
siguiente URL:
|
|
|
|
|
|
> Base URL: https://use-case-5-dev.cmobility30.es:8443/usecase5
|
|
|
- Todas las respuestas son en **formato JSON**.
|
|
|
|
|
|
## Versión
|
|
|
|
|
|
El versionado de la API se determina en la propia URL. Por ejemplo, para la
|
|
|
versión 1 obtendremos la siguiente URL:
|
|
|
|
|
|
> {baseUrl}/<mark>v1</mark>/XXXX
|
|
|
> {baseUrl}/<mark>v1</mark>/xxx....
|
|
|
|
|
|
## Autentificación
|
|
|
|
|
|
- Como paso previo a la obtención del token, se debe poseer el certificado de seguridad y que la IP esté en la lista de permitidas.
|
|
|
|
|
|
- Para utilizar los *endpoints* de la API se debe obtener un **token** de acceso válido. Una vez se obtiene, se debe adjuntar en las cabeceras HTTP con cada petición que se realice.
|
|
|
|
|
|
- El **cn** del usuario registrado en el sistema debe ser enviado como parámetro.
|
|
|
<u>{baseUrl}/v1/token?<mark>cn=prueba</mark></u>
|
|
|
|
|
|
<img src="https://i.loli.net/2021/03/24/jAPwrbJnsd6e7zH.png" title="" alt="2021-03-24-13-25-45-image.png" data-align="center">
|
|
|
|
|
|
- Si la autentificación es válida, obtendrás un token válido que expira en un determinado tiempo. Cuando el token expira, se recibe un error **HTTP 400 – Bad Request** con la respuesta como en el siguiente ejemplo. Se debe solicitar un nuevo token para continuar realizando peticiones a la API.
|
|
|
- Si la autentificación es válida, se obtiene una respuesta con la fecha y hora en la que se ha generado, en la que expira y el propio token.
|
|
|
|
|
|
```
|
|
|
{
|
|
|
"issuedAt": "2021-04-01T09:09:16.284",
|
|
|
"expiration": "2021-04-02T09:09:16.284",
|
|
|
"token": "Bearer eyJhbGciOiJIUzUxMiJ9.e......."
|
|
|
}
|
|
|
```
|
|
|
|
|
|
- Además, si se realiza una petición con un token expirado se recibe un error **HTTP 400 – Bad Request** con la respuesta como en el siguiente ejemplo. Se debe solicitar un nuevo token para continuar realizando peticiones a la API.
|
|
|
|
|
|
```
|
|
|
{
|
... | ... | |