ICAROSoft

Guía Técnica para Desarrolladores API

👨‍💻 Aquí encontrarás toda la información técnica para integrar la API.

🔗 Endpoint URL 

Toda la comunicación se realiza a través del siguiente punto de conexión:

https://api.icarosoft.com/helpdesk-status/

Método HTTP

  • GET

🔑 Autenticación y Parámetros

La autenticación es simple y se realiza directamente en la URL. Debes incluir los siguientes parámetros en cada petición:

Parámetro

Obligatorio

Descripción

token

 ✅

Tu token de seguridad único proporcionado por ICAROSoft.

empresa

 ✅

El identificador de tu empresa (ej: icarosoft).

sucursal

 ✅

El identificador de la sucursal a consultar (ej: mcbo1).

Ejemplo de Petición:

Así se ve una URL completa y lista para usar. ¡Puedes probarla en tu navegador!

    https://api.icarosoft.com/helpdesk-status/?token=icadasd2cqgx123b&empresa=icarosoft&sucursal=mcbo1

 Respuesta Exitosa (Código 200 OK)

Si tu petición es correcta, recibirás un objeto JSON con dos bloques principales: resumen_general y detalle_por_tiempo_espera.

Ejemplo de Respuesta JSON:

    {

    «resumen_general»: {

        «chat_nuevos»: 15,

        «chat_pendientes»: 5,

        «chat_asignados»: 22,

        «chat_icarobot_ia»: 8,

        «chat_abiertos»: 50,

        «chat_cerrados»: 1250,

        «chat_en_espera_del_cliente»: 3,

        «chat_tiempo_espera_menos_10min»: 12,

        «chat_tiempo_espera_20min»: 8,

        // … otros rangos de tiempo

    },

    «detalle_por_tiempo_espera»: {

        «menos_10_minutos»: [

            {

                «id_resumen»: 1001,

                «id_cliente»: «CLI001»,

                «departamento»: «Ventas»,

                «numero_perfil»: «+15551234567»,

                «numero_cliente»: «+15559876543»,

                «nombre_cliente»: «Juan Perez»

            }

        ],

        // … otros arrays con detalles de chats

    }

}

 Posibles Errores

Si algo sale mal, recibirás un código de error y un mensaje claro para ayudarte a solucionarlo.

Código HTTP

Mensaje de Error

Causa Probable

400

{«message»: «Faltan parámetros…»}

Olvidaste enviar alguno de los parámetros requeridos (token, empresa, sucursal).

401

{«message»: «Unauthorized: Token no válido»}

El token que enviaste no es el correcto para esa empresa y sucursal.

404

{«message»: «No se encontró configuración…»}

La combinación de empresa y sucursal no existe en nuestro sistema.

⚙️ Proceso de Activación

¿Listo para empezar? ¡Es muy fácil!

1️ Contacto Inicial: Habla con nuestro equipo comercial para contratar el servicio de la API Helpdesk Status.

2️ Generación de Credenciales: Nuestro equipo técnico creará tu token de seguridad único y secreto.

3️ Entrega de URL: Te enviaremos tu URL personalizada, ¡lista para usar!

4️ ¡A Integrar! Tu equipo de desarrollo ya puede empezar a conectar la API con sus sistemas.

¡Esperamos que esta herramienta potencie la gestión y el éxito de tu Helpdesk! Si tienes alguna pregunta, no dudes en contactar a nuestro equipo de soporte.

Deja un comentario

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *