Desarrolladores
Todo lo que un residente o un empleado puede hacer en SportsMgnt pasa por las mismas reglas que usa la API. La API es JSON sobre HTTPS en /api/v1.
Lo básico
- Las respuestas usan un sobre: data, y meta con los totales de paginación. Los errores usan una sola forma: error.code, error.message y error.fields.
- Las lecturas públicas del catálogo y de las instalaciones no necesitan token. Las solicitudes anónimas tienen un límite de 60 por minuto.
- Todo lo demás necesita un token de acceso personal en el encabezado Authorization. Los tokens tienen un límite de 120 solicitudes por minuto.
Pruébelo
curl 'https://sportsmgnt.com/api/v1/health' -H 'Accept: application/json'
curl 'https://sportsmgnt.com/api/v1/me/token' -H 'Authorization: Bearer SU_TOKEN'Crear un token
- Inicie sesión (por ejemplo, con el perfil de residente) y abra Seguridad y luego Tokens de la API.
- Elija los permisos que necesita el token y un vencimiento de hasta 90 días.
- Copie el token: se muestra una sola vez. Revóquelo desde la misma página.
Tokens de API · Personajes de demostración
Permisos
| Permisos | Descripción |
|---|---|
| catalog:read | Leer el catálogo público |
| household:read | Leer mi hogar, miembros, inscripciones y calendario |
| household:write | Cambiar mi hogar y mi carrito |
| facilities:read | Leer instalaciones y disponibilidad |
| reservations:write | Solicitar reservas de instalaciones |
| staff:rosters | Leer listas (personal, según mis funciones) |
| staff:attendance | Registrar asistencia (personal, según mis funciones) |
| staff:reports | Ejecutar informes (personal, según mis funciones) |
Los tokens del personal también se limitan según la función y los lugares del empleado.
Insertar el catálogo en un sitio web
Añada una etiqueta de script donde deba aparecer el componente. El script inserta un iframe que ajusta su altura al contenido, así que no hay barra de desplazamiento dentro del marco.
<script src="https://sportsmgnt.com/embed.js" data-widget="catalog" data-lang="es"
data-category="aquatics" data-primary="5b2a86" data-accent="0f7b6c"
data-title="Catálogo de actividades de Kestrel Basin Parks (SportsMgnt)"></script>Atributos
data-widget- catalog o facilities
data-lang- en o es
data-category,data-location,data-type- filtros opcionales, por ejemplo una categoría o el código de un lugar
data-primary,data-accent- los colores de su sitio en hexadecimal de seis dígitos, aplicados dentro del componente
data-title- el nombre accesible del marco
Las páginas del componente muestran el aviso de demostración y la nota de datos de ejemplo. Los sitios que pueden enmarcarlas se indican en el ajuste de inserción.