API: Métodos relacionados con la información del usuario

Importante: Para acceder a estos métodos es necesario tener un token de acceso (access_token) obtenido mediante una petición de autenticación y autorización con un scope de tipo profile, para lo que hay que seguir los pasos indicados en esta sección de la documentación.

Obtener datos del usuario

Con este método podemos ver los datos de un usuario de Viafirma Fortress, tales como nombre, correo electrónico, teléfono móvil, sus certificados, ...

Uso del servicio

Método: GET
URL: {viafirma_fortress_url}/api/v1/user/{user_code}

Donde:

• viafirma_fortress_url: URL base de la implementación de Viafirma Fortress, por ejemplo https://sandbox.viafirma.com/fortress o https://fortress.viafirma.com/fortress
• user_code: Código del usuario del que se desea obtener la información

Además, en la cabecera HTTP de la petición GET debe incluirse el token de acceso (access_token) de la siguiente forma:

Authorization: Bearer {access_token}

Ejemplo:

Método: GET
URL: https://fortress.viafirma.com/fortress/api/v1/user/sample_user
Header de la petición: Authorization: Bearer 0b79bab50daca910b000d4f1a2b675d604257e42

Respuesta del servicio

La respuesta de este servicio vendrá dada (en formato application/json) de la siguiente forma:

{
  "code": "sample_user",
  "name": "Name Surname",
  "email": "[email protected]",
  "mobile": "+34666666666",
  "lastAccess": 1501590523833,
  "role": "ROLE_USER",
  "certificates": [
    {
      "code": "226ffa94-1f0f-4c43-98aa-c7c8e4ccf657",
      "name": "Sample Certificate 01",
      "description": "Lorem ipsum dolor sit amet",
      "dateIssued": 1492432671000,
      "dateExpired": 1555504674000,
      "serialNumber": "1250978750360690486",
      "issuer": "C=DO, L=WWW.AVANSI.COM.DO, O=AVANSI S.R.L. - RNC 130222509, CN=TEST AVANSI CERTIFICADOS DIGITALES",
      "subject": "OID.1.3.6.1.4.1.27395.8.1=CERTIFICADO DE PERSONA INDIVIDUAL, CN=Sample Certificate 01, SERIALNUMBER=TEST, GIVENNAME=TEST, SURNAME=TEST, C=DO"
    },
    {
      "code": "014e684e-4751-4850-853c-c90802385a78",
      "name": "Sample Certificate 02",
      "description": "Lorem ipsum dolor sit amet",
      "dateIssued": 1492517893000,
      "dateExpired": 1555504678000,
      "serialNumber": "4096319273351924161",
      "issuer": "C=DO, L=WWW.AVANSI.COM.DO, O=AVANSI S.R.L. - RNC 130222509, CN=TEST AVANSI CERTIFICADOS DIGITALES",
      "subject": "OID.1.3.6.1.4.1.27395.8.1=CERTIFICADO DE PERSONA INDIVIDUAL, CN=Sample Certificate 02, SERIALNUMBER=TEST, GIVENNAME=TEST, SURNAME=TEST, C=DO"
    }
  ]
}

Donde:

Errores del servicio

Los errores devueltos por el servicio (devueltos en formato application/json) tienen el siguiente aspecto:

{
  "error": "error_code",
  "error_description": "error_description"
}

Donde:

Posibles errores:

Obtener estado del usuario

Con este método podemos ver el estado de un usuario de Viafirma Fortress. Este estado nos indicará, entre otras cosas, si el usuario está activo, si dispone de algún certificado, si está enrolado en algún Proveedor de Identificación…

Uso del servicio

Método: GET
URL: {viafirma_fortress_url}/api/v1/user/{user_code}/status

Donde:

• viafirma_fortress_url: URL base de la implementación de Viafirma Fortress, por ejemplo https://sandbox.viafirma.com/fortress o https://fortress.viafirma.com/fortress
• user_code: Código del usuario del que se desea obtener el estado

Además, en la cabecera HTTP de la petición GET debe incluirse el token de acceso (access_token) de la siguiente forma:

Authorization: Bearer {access_token}

Ejemplo:

Método: GET
URL: https://fortress.viafirma.com/fortress/api/v1/user/sample_user/status
Header de la petición: Authorization: Bearer 0b79bab50daca910b000d4f1a2b675d604257e42

Respuesta del servicio

La respuesta de este servicio vendrá dada (en formato application/json) de la siguiente forma:

{
  "sign": true,
  "auth": true
}

Donde:

Errores del servicio

Los errores devueltos por el servicio (devueltos en formato application/json) tienen el siguiente aspecto:

{
  "error": "error_code",
  "error_description": "error_description"
}

Donde:

Posibles errores:

Eliminar la caché de credenciales

Con este método podemos eliminar la caché de credenciales de un usuario de Viafirma Fortress.

Uso del servicio

Método: DELETE
URL: {viafirma_fortress_url}/api/v1/user/{user_code}/removeAuthCache

Donde:

• viafirma_fortress_url: URL base de la implementación de Viafirma Fortress, por ejemplo https://sandbox.viafirma.com/fortress o https://fortress.viafirma.com/fortress
• user_code: Código del usuario del que se desea obtener la información

Además, en la cabecera HTTP de la petición DELETE debe incluirse el token de acceso (access_token) de la siguiente forma:

Authorization: Bearer {access_token}

Ejemplo:

Método DELETE
URL: https://fortress.viafirma.com/fortress/api/v1/user/sample_user/removeAuthCache
Header de la petición: Authorization: Bearer 0b79bab50daca910b000d4f1a2b675d604257e42

Errores del servicio

Los errores devueltos por el servicio (devueltos en formato application/json) tienen el siguiente aspecto:

{
  "error": "error_code",
  "error_description": "error_description"
}

Donde:

Posibles errores: