dev-cucei-itrans/siiau-api-client

Simple SDK for interacting with SIIAU web service

v1.1.3 2024-10-08 21:34 UTC

Requires

• php: ^8.1
• illuminate/collections: *
• saloonphp/cache-plugin: ^3.0
• saloonphp/laravel-plugin: ^3.0
• saloonphp/saloon: ^3.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.34
• laravel/facade-documenter: dev-main
• orchestra/testbench: ^8.13 || ^9.0
• pestphp/pest: ^2.20

BSD-3-Clause

• Oscar Eduardo Arámbula Vega
• Abraham Israel Lopez Eguiarte

• client
• sdk
• laravel
• siiau

README

Un SDK para proyectos de Laravel que facilita interactuar con la API interna de SIIAU de la Universidad de Guadalajara.

Instalación

Para descargar e instalar el paquete, puedes hacer uso de Composer en tu proyecto y ejecutar el comando:

composer require dev-cucei-itrans/siiau-api-client

Configuración

Agrega las siguientes variables de entorno a tu proyecto con las credenciales de acceso correspondientes.

SIIAU_WS_URL="https://example.siiau.com"
SIIAU_WS_EMAIL="[e-mail]"
SIIAU_WS_PASSWORD="YourSecurePassword"

Uso

Para interactuar con la API, se puede hacer uso del helper siiau(). Este helper permite acceder a los métodos de forma sencilla.

$alumno = siiau()->alumno()->encontrar(
    codigo: '123456789',
);

Para más información sobre los métodos disponibles y caracteristicas del SDK, puedes revisar la documentación.

Contribución

Cualquier sugerencia, problema o duda generar un nuevo issue si es que no existe uno que lo describa ya.