Configurar credenciales y validar la conexión con la API de Ayudaparacontadores.com

La API de Ayudaparacontadores.com utiliza tecnología REST y entrega las respuestas en formato JSON.

Esto permite que sistemas externos se conecten y consulten información de forma automática desde Ayudaparacontadores.com.

Generar credenciales de acceso

Antes de utilizar la API, es necesario generar las credenciales de acceso para la empresa correspondiente.


Paso 1: Seleccionar la empresa

Desde el Directorio de Empresas, seleccione la empresa para la cual desea habilitar el acceso a la API.

Empresas - Directorio Empresas


Paso 2: Acceder a las credenciales API

En el menú Adicionales, seleccione la opción: Credenciales API Ayudaparacontadores.com

Crear o renovar credenciales

Para generar nuevas credenciales o reemplazar las existentes, presione el botón:

Generar / Renovar Credenciales

El sistema generará automáticamente un nuevo par de credenciales:

  • api_key  
  • api_secret  

Importante

Cada vez que se renuevan las credenciales, las credenciales anteriores dejan de funcionar inmediatamente.


Eliminar credenciales

Si desea desactivar el acceso a la API, utilice la opción:

Eliminar Credenciales

Al eliminar las credenciales, cualquier integración que utilice dichas credenciales dejará de poder conectarse a la API.


Utilizar las credenciales en las solicitudes

Las credenciales deben enviarse en la cabecera (Header) de cada solicitud realizada a la API.

Cabeceras requeridas

X-Api-Key: [valor api_key] X-Api-Secret: [valor api_secret] Content-Type: application/json

Estas cabeceras son obligatorias y deben incluirse en todas las solicitudes enviadas al sistema.


Verificar el estado de la API

Puede comprobar la disponibilidad y el funcionamiento de la API utilizando el siguiente endpoint:

https://sistema.ayudaparacontadores.com/api/v1/health

Respuesta esperada

{  "ok": true,  "version": "v1" }

Si obtiene una respuesta similar, significa que la API se encuentra operativa y disponible para recibir solicitudes.

¿Respondió esto a su duda? Gracias por su respuesta Hay un problema con su respuesta, por favor intente mas tarde