API

Con la API proporcionada por Modela podemos realizar las siguientes acciones:

  • Obtener la información necesaria para rellenar una solicitud. Existen una serie de métodos en la API que nos permiten obtener toda la información para generar una nueva solicitud.
  • Obtener el estado actual de una solicitud.
  • Crear una nueva solicitud.
    • Existen las siguientes limitaciones a la hora de crear una solicitud desde la API
      • No podemos enviar adjuntos. Ni adjuntos de información general ni adjuntos de campos propios de la solicitud
      • Modela no nos proporciona un servicio para obtener los usuarios de Azure, por lo que para informar campos del tipo «Lista de usuarios», a los que debemos enviar el «object id» del usuario en Azure, debemos conocer de antemano dicho valor
    • Podemos crear una solicitud en estado «Borrador» e informar los valores que no nos permite la API directamente desde la web de Modela

Como usar

Para que podamos realizar las llamadas a la API, tenemos que tener configurado un token del tipo correspondiente a la acción que vamos a ejecutar.

El token configurado debemos enviarlo en la cabecera de las peticiones con el nombre «token».

Ejemplo de una llamada, donde {REPLACE_INSTANCE_GENERATED_TOKEN} debe ser el valor del token:

curl --location 'https://demo.getmodela.com/public/external/form/company' \
--header 'token: {REPLACE_INSTANCE_GENERATED_TOKEN}' 

Posibles errores de uso

En caso de error al enviar el Token (no se envía, no es valido, está caducado, no es de la sociedad correspondiente a la solicitud), Modela nos devolverá el error 401 (Unauthorized)

Si el error es al procesar la petición realizada a la API, Modela devolverá el error 400 (Bad Request) junto con una mensaje indicando el código de error. En el apartado de cada método podemos ver que posibles errores nos devolverá.

Ejemplo de respuesta con error:

{
    "message": "PROCESS_NOT_FOUND"
}

Métodos

Los métodos que tiene la API nos servirán para:

Was this article helpful?

Related Articles

¿Necesitas ayuda?

Contacta con nosotros.
Contacta con soporte