Referencia de la Clase api

Diagrama de herencias de api

Métodos públicos
	habilitaciones ()
	login ()
	logout ()
	tipos_recurso ()

Documentación de las funciones miembro

habilitaciones()

habilitaciones

(

)

Obtiene las habilitaciones disponibles.

Notas

• SATISFACTORIO 
  Esta habilitación indica si se ha cumplimentado el 100% de la documentación requerida.
• ACCESO 
  Esta habilitación indica si se el recurso se encuentra habilitado para acceder al lugar de trabajo. Tenga en cuenta que no toda la documentación adeudada restringe el acceso, por lo que mientras en la habilitación de SATISFACTORIO el estado de habilitado podría ser false, el estado de habilitado en ACCESO podría ser true, lo que indica que el recurso TIENE PERMITIDO el acceso aunque adeude alguna documentación.

Url

• Usuarios con perfil comitente:

      https://auditium.com.ar/ruc/api_comitentes/habilitaciones

• RPA's:

      https://auditium.com.ar/ruc/api_ia/habilitaciones

Method

    GET

Headers

• token (string) 
  El token obtenido al realizar login().

Devuelve

array

• data (array)
  Lista de habilitaciones disponibles.
  

• _links (array)
  Lista de acciones disponibles en la API. Todos los endpoints devuelven este valor.

Desde

15/05/2024

Versión

08/09/2025

Autor

Gustavo Pardo gusta.nosp@m.vo.p.nosp@m.ardo@.nosp@m.data.nosp@m.neu.c.nosp@m.om.a.nosp@m.r

login()

login

(

)

Obtiene un token de acceso a la API con las credenciales proporcionadas.

Url

• Usuarios con perfil comitente:

      https://auditium.com.ar/ruc/api_comitentes/login

• RPA's:

      https://auditium.com.ar/ruc/api_ia/login

Method

    GET

Headers

• user (string) 
  El usuario de la API (no es el mismo que usa al ingresar mediante el navegador). Si todavía no tiene un usuario API, puede solicitarlo al auditor.

• password (string)
  La contraseña correspondiente al usuario.

Devuelve

array

• token (string)
  El token que deberá incluír en el encabezado de cada llamada que realice a la API. Tiene una validez de 90 minutos, al cabo de los cueles deberá realizar un nuevo login para renovarlo.

• token_expiration (timestamp)
  La fecha/hora del vencimiento del token.

• _links (array)
  Lista de acciones disponibles en la API. Todos los endpoints devuelven este valor.

Desde

10/05/2024

Versión

08/09/2025

Autor

Gustavo Pardo - gusta.nosp@m.vo.p.nosp@m.ardo@.nosp@m.data.nosp@m.neu.c.nosp@m.om.a.nosp@m.r

logout()

logout

(

)

Desactiva el token vigente.

Url

• Usuarios con perfil comitente:

      https://auditium.com.ar/ruc/api_comitentes/logout

• RPA's:

      https://auditium.com.ar/ruc/api_ia/logout

Method

    GET

Headers

• token (string) 
  El token obtenido al realizar login().

Devuelve

Mensaje de aviso de token desactivado.

Desde

14/05/2024

Versión

08/09/2025

Autor

Gustavo Pardo gusta.nosp@m.vo.p.nosp@m.ardo@.nosp@m.data.nosp@m.neu.c.nosp@m.om.a.nosp@m.r

tipos_recurso()

tipos_recurso

(

)

Obtiene los tipos de recurso disponibles.

Url

• Usuarios con perfil comitente:

      https://auditium.com.ar/ruc/api_comitentes/tipos_recurso

• RPA's:

      https://auditium.com.ar/ruc/api_ia/tipos_recurso

Method

    GET

Headers

• token (string) 
  El token obtenido al realizar login().
• hateoas (boolean) 
  Opcional. Si se envía con un valor false omite los enlaces hipermedia. Predeterminado: true.

Devuelve

array

• data (array)
  Lista de los tipos de recurso disponibles.
  

• _links (array)
  Lista de acciones disponibles en la API. Todos los endpoints devuelven este valor.
  

Desde

15/05/2024

Versión

08/09/2025

Autor

Gustavo Pardo gusta.nosp@m.vo.p.nosp@m.ardo@.nosp@m.data.nosp@m.neu.c.nosp@m.om.a.nosp@m.r

---

La documentación para esta clase fue generada a partir del siguiente fichero:

• api.php