API DE SENET

Información general 

    El sistema SENET tiene su propia API, que permite la integración con otros programas, la interacción con el servidor y la creación de nuevas aplicaciones. El aspecto de la aplicación del uso de la API del servidor de SENET:   

1. automatización de los informes. La integración con programas como Power BI permitirá elaborar informes periódicos sobre el rendimiento del club en la forma adecuada, analizando y visualizando los datos; 
2. amplias posibilidades de registro. Un formulario de inscripción en línea permitirá a los clientes crear cuentas mientras están fuera del club. También se puede organizar el registro de los clientes en el mostrador del club (por ejemplo, a través de una aplicación en una tableta) para aliviar la carga de trabajo de los administradores; 
3. simplificar el trabajo con la base de usuarios para llevar a cabo actividades de marketing. La API le permite analizar la estructura de género y edad de su base de clientes, identificar las fuentes de atracción más populares, cargar números de teléfono/correo electrónico para las promociones y establecer una comunicación con los clientes basada en la fecha de la última visita, el dinero gastado, el saldo de la cuenta, etc. Esta opción le permite construir un proceso de compromiso continuo para sus clientes y crear una fuerte comunidad en su club.  

    El funcionamiento de la API se basa en HTTP, es decir, se utiliza el protocolo HTTP para intercambiar datos/solicitudes entre los dos sistemas. La transferencia de datos de un servidor a otro se realiza mediante CURL. 

Solicitudes que se pueden realizar (según HTTP):  

• GET - recuperar el recurso  
• POST - crear el recurso 
• PATCH - cambiar el recurso 
• DELETE - eliminar el recurso. 

La API del servidor de SENET admite el formato de fecha y hora según la norma ISO 8601. Ejemplo:   

• 2020-12-21T15:22:22Z  
• 2020-12-21T12:22:22-03   
• 2020-12-21T17:22:22+02. 

En cuanto al número de teléfono, su formato debe ser + [código de país][código de región][número de teléfono]. Ejemplo:  

•  [phone]   
• [phone]   
• +01234567890   
• [phone].  

La API se puede encontrar en https://orgname.api.enes.tech/docs/#/ , donde orgname es el nombre del servidor. 

Autorización 

    Para comunicarse con el servidor a través de APL, primero debe estar autorizado. Hay dos tipos de autorización en el sistema:   

     1) por Application Key - no está destinado al uso público, realiza peticiones entre dos servidores. Por ejemplo, necesita cargar una lista de usuarios registrados en el club y transferirla a otro programa.  

     Para autorizar por clave de aplicación, haga clic en Authorize. En el campo Value especifique la clave API recibida con el prefijo key al principio (Ejemplo: key 23097e83-c473-49a3-b268-53c4fb712257) y haga clic de nuevo en Authorize.  

    Para obtener Application Key (una clave de aplicación), póngase en contacto con el servicio técnico. Recomendamos que se cree una Clave de Aplicación separada para cada miembro del personal que trabaje con АРІ, de modo que se pueda hacer un seguimiento de quién ha hecho qué, si es necesario. 

    2) por Bearer Token - generado por el servidor en respuesta a una solicitud de inicio de sesión. Se genera un token distinto para cada usuario. Se puede utilizar públicamente. Por ejemplo, los clientes deben poder editar su cuenta Shell en el sitio web del club. 

     Para obtener un Bearer Token, vaya a la sección Login, haga clic en POST y luego en Try it out. En el cuerpo de la solicitud, indique su nombre de usuario y contraseña para la cuenta de usuario y haga clic en Execute. Para cancelar la solicitud, haga clic en Cancel.

    En respuesta a la solicitud, los datos volverán con la información del usuario, especificando el Bearer Token para ese usuario.

    Para autorizar por medio de un Bearer Token, haga clic en Authorize. Introduzca el token recibido en el campo Value y haga clic de nuevo en Authorize. 

Nota: la autorización debe realizarse después de cada recarga de la página.

Descripción de las solicitudes 

Account - trabajar con las cuentas. 

• GET /account / - obtener la lista de usuarios 
• PATCH /account/{login}/ - editar el perfil del usuario 
• GET/account/{login}/balance-history/ - obtener los datos del balance del usuario 
• GET /account/{login}/tickets/ - obtener los detalles de las entradas del usuario 
• POST /account/register/ - registrar la cuenta 

Cashdesk - operaciones de caja. 

• GET/cashdesk/{cashdesk_id}/cashdesk_operations/ - obtener datos sobre las operaciones de caja 

Para ejecutar la solicitud, es necesario especificar el ID de la caja registradora (puede obtenerlo del soporte técnico). 

Login 

• POST/login/ - Solicitud para iniciar sesión y obtener información sobre un usuario específico 

Logout 

• POST /logout/ - Solicitud para salir de la cuenta 

Me - trabajo con el acceso público de un usuario específico. El acceso a la sección se concede después de la autorización mediante un Bearer Token. 

• GET /me/ - recuperar los detalles de la cuenta de usuario 
• PATCH /me/ - cambiar los detalles del perfil del usuario 
• DELETE /me/ - eliminar la cuenta 
• POST/me/email/ y POST/me/email/confirm/ - utilizados para cambiar el correo electrónico. Se enviará un código de confirmación al nuevo correo y deberá introducirse en la solicitud de cambio de correo 
• POST /me/password/ - establecer una nueva contraseña 

Reports - las consultas proporcionan datos dentro de esos reportes que pueden ser descargados desde el panel de administración. 

Users - trabajo con los usuarios. 

• POST/users/ - crear un perfil de usuario 
• POST/users/activate/ - activar el perfil del usuario. Se enviará un código de confirmación al correo 
• POST/users/refill/ - recargar saldo
• POST /users/resend_activation_code/ - reenviar el código de activación de la cuenta 

Workstations - trabajo con puestos de trabajo. 

• GET/workstations/ - obtener la lista de estaciones de trabajo 
• POST/workstations/login/ - iniciar una sesión de usuario

    Puede encontrar ejemplos de valores y su formato para cada bloque de datos en la sección Schemas. 

    Puede trabajar con los datos directamente a través de la API, donde puede descargarlos en formato xlsx y json.

    También hay otras formas de manejar los datos recibidos a través de API. Por ejemplo, la plataforma Postman se utiliza ampliamente para estos fines. Linux tiene un comando con URL incorporado para esto. Para darles salida a los datos de la API, ejecute la consulta que desee y cópiela de la URL.  

    Si tiene alguna duda sobre el API o tiene alguna pregunta sobre su funcionamiento, póngase en contacto con nuestro equipo de soporte técnico.