Índice de contenidos

• Introducción
• Documentación y endpoint (punto final de API) 
  • Clave de API
  • Token
  • Branches y Branch_id
• Herramientas para la prueba de claves de API 
• Integración web corporativa 
  • Listado de clubes/filiales
  • Listado de actividades
    
• Integración contable
• Facturación electrónica 

Introducción

Las API de SPORTRICK consisten en un conjunto de llamadas que permite a los desarrolladores acceder a toda la información contenida en el sistema de gestión. Los escenarios de uso más comunes son muchos pero se destacan los más frecuentes: 

• Obtención de información contable; 
• Integración entre SPORTRICK y la web y/o app para smartphone con funcionalidad de reserva y venta online; 
• Implementar nuevas funcionalidad a la web o app para smartphone de un centro deportivo; 
• Empresas de terceros que quieran integrar su aplicación con el universo SPORTRICK; 
• Automatización para domótica e IoT
• …

Documentación y endpoint (punto final de API)

La lista completa de llamadas disponibles se puede encontrar en la siguiente dirección:

El punto final de API genérico para todas las llamadas es el siguiente:

A seguir, es necesario insertar la llamada API específica.

Clave de API

La clave para hacer una llamada es la clave de API. Esta clave se utiliza para identificar el entorno que se va a consultar. La clave de API es obligatoria para realizar todas las llamadas, excepto para las autollamadas en las que se debe usar el Token La clave de api es secreta. Es posible pedir una clave de API de la siguientes formas:

• Clave de API de prueba: clave para entorno de prueba --> enviar un correo a sales@sportrick.com
• Calve de API de producción: la petición de esta clave puede ser tramitada sólamente por el administrador del centro

Token

El token es la clave que utiliza el sistema para identificar al usuario final (cliente). Esta clave solo se puede obtener si el cliente tiene una cuenta válida (nombre de usuario y contraseña) para acceder al portal de usuario SPORTRICK del entorno correspondiente (ecomm.sportrick.com/nombredelentorno). 

El token es obligatorio para poder utilizar las llamadas indicadas en la sección self. Estas llamadas son específicas para recuperar información sobre el usuario individual y por ello requieren el uso del token.

El token tiene una validez fija. En la fase de prueba esta validez se establece en 24h. Será posible antes de la puesta en producción, decidir qué validez establecer.

Branches y Branch_id

En SPORTRICK hay otro identificador necesario que se usa para identificar aún más el club de forma individual: branch_id.

Dentro del entorno único identificado por la APIKEY puede haber 1 o más sub-entornos (que coinciden con los clubs) que son identificados por branch_id. Las filiales (Branches) suelen ser obligatorias para el uso de ciertas APIs, por eso siempre es recomendable tener una configuración en tu aplicación donde se guarden estos identificadores.

Asegúrese de que la filial que desea obtener, tenga habilitado el uso compartido web (Configuración--> Perfil en el menú de configuración de SPORTRICK)

Herramientas para la prueba de claves API 

Hay muchas herramientas que se pueden usar para probar las API, pero podemos recomendar las siguientes dos metodologías:

1. Prueba directa desde la página de la documentación. En la página de documentación (https://api.sportrick.cloud/help/index) es posible probar directamente las llamadas, usando el botón "¡Pruébalo!" presente en cada sección específica de una llamada a la API. En cada sección es posible compilar una solicitud con todos los parámetros requeridos por la llamada a la API. Además, en la barra superior de la página es posible configurar el Apikey y el Token que luego se utilizarán para probar la llamada.
2. Software postman. El software indicado permite realizar llamadas, aprovechar el guardado automático de parámetros (como el Token) para usar en llamadas posteriores y permite guardar una serie de llamadas API que se pueden recuperar más tarde. Para agilizar la configuración y el uso de la API, puede solicitarnos que recopilemos las llamadas para que pueda iniciar las pruebas más fácilmente, importando directamente la lista de llamadas disponibles.

Integración web corporativa

Uno de los posibles usos de la API de SPORTRICK es integrar cierta información en una página web. 

Para la integración de un sitio web institucional es necesario contar con la Clave de API. A través de la Clave de API se pueden realizar todas las llamadas para obtener información sobre los siguientes parámetros. . Esta información tiene carácter global, es decir, concierne a todo el club (basta con utilizar la Clave de API para acceder a esta información). 

Listado de clubes/filiales (Branches)

La llamada de integración de las filiales vista anteriormente, se puede usar y vincular a una página de presentación de club/instalación. Obviamente se recomienda integrar la información que devuelven las llamadas a la API con imágenes o detalles adicionales (posición geográfica) para crear un mapa interactivo de los distintos sistemas pertenecientes a la empresa.

La lista de filiales se puede utilizar como punto de partida para consultar la planificación y otra información específica del centro. 

Listado de actividades

Muy a menudo surge la necesidad de integrar la visión de las actividades y servicios que ofrece la instalación/club. También en este caso se recomienda integrar la información obtenida de SPORTRICK con las llamadas API con información adicional como imágenes y descripciones.

Integración contable

Para la integración contable ponemos a disposición del integrador las siguientes API:

Facturación electrónica

Hablando de facturación electrónica se puede integrar la llamada anterior mediante el parámetro forDigitalInvoicing. 

Si desea gestionar la facturación electrónica con SPORTRICK de forma estructurada, una vez descargados los documentos, debe comunicarlo al sistema con las siguientes llamadas: