Crear socio y asignarle una subcategoría desde la API
En este artículo se describen las peticiones necesarias para crear un socio y asignarle una subcategoría utilizando la API de Playoff.
URL de referencia
Para este ejemplo se utiliza la siguiente URL base:
La URL del artículo es http://cienciasrugby.playoffinformatica.local, en un caso real se debería utilizar la de cada cliente con protocolo HTTPS, por ejemplo https://playoff.playoffinformatica.com
Obtener el token de autenticación
Antes de realizar cualquier llamada a la API, es necesario obtener un token de autenticación.
Las credenciales utilizadas deben corresponder a un usuario con rol de administrador.
LOGIN
Ejemplo de petición POST para obtener el token:
y recibiríamos el token en la respuesta, este token será necesario para las demás peticiones a realizar.
Crear socio
Para crear un nuevo socio mediante la API, primero es necesario conocer el identificador del municipio si deseas indicar su localidad.
Este identificador se obtiene a partir del código postal.
Obtener el identificador del municipio
Ejemplo de petición GET para obtener el identificador del municipio mediante el código postal:
y obtenemos el idMunicipio:
ahora sí podemos realizar la petición para crear el socio:
En este ejemplo estaríamos generando un socio en estado de alta (idEstatColegiat = 1) y preinscrito (estat = COLESTPRE).
Los posibles valores del sexo serían SXMAS para masculino y SXFEM para femenino.
A continuación se muestra la respuesta de esta petición donde se recibe el identificador del socio:
ASIGNAR UNA SUBCATEGORÍA AL SOCIO
Primero necesitamos saber los identificadores de las subcategorías, esta es la petición:
y la respuesta donde el campo importante es idModalitat:
para asignar la subcategoría al socio sería esta petición:
La "dataProperaGeneracio" y el "tipusperiodicitat" solo tienen sentido cuando se traten de subcategorías a facturar, no son necesarios cuando no haya facturación asociada.
Cuando se trate de una subcategoría a facturar la "dataProperaGeneracio" (fecha próxima generación) significa a partir de que fecha se generaría el recibo para esta subcategoría.
Estos son los posibles valores de la periodicidad: 1 - mensual, 2 - semestral, 3 - anual, 4 - trimestral, 5 - bimensual y 6 - quadrimestral.
DOCUMENTACIÓN
En el siguiente enlace se encuentra la documentación a la API: https://api.playoffinformatica.com/