PHPackages                             itcolima/siitec2-api-client - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. itcolima/siitec2-api-client

Abandoned → [itcolima/siitec-api-client](/?search=itcolima%2Fsiitec-api-client)Library[API Development](/categories/api)

itcolima/siitec2-api-client
===========================

PHP ITColima SIITEC 2 API Client

v0.1.31(4y ago)1172PHP

Since Jan 26Pushed 4y ago1 watchersCompare

[ Source](https://github.com/tecnm-colima/siitec2-api-client)[ Packagist](https://packagist.org/packages/itcolima/siitec2-api-client)[ RSS](/packages/itcolima-siitec2-api-client/feed)WikiDiscussions master Synced 3w ago

READMEChangelog (10)Dependencies (5)Versions (33)Used By (0)

Cliente PHP de la API de SIITEC 2
=================================

[](#cliente-php-de-la-api-de-siitec-2)

Instalación
-----------

[](#instalación)

La instalación del paquete se puede hacer mediante **composer** utilizando el siguiente comando:

```
composer require itcolima/siitec2-api-client

```

Inicialización
--------------

[](#inicialización)

La forma de inicializar la API de SIITEC 2 es mediante la clase `ITColima\Siitec2\Api\Siitec2Api`.

```
use ITColima\Siitec2\Api\Siitec2Api;

// Carga manual de las variables de entorno
$_ENV['SIITEC2_API_CLIENT_ID'] = '';
$_ENV['SIITEC2_API_CLIENT_SECRET'] = '';

$api = new Siitec2Api();
```

> **Carga automática de las variables de entorno `$_ENV`**La API de SIITEC 2 puede cargar automáticamente las variables de entorno si se utiliza un framework o librería que las cargue desde un archivo `.env`. En el archivo deberían incluirse de la siguiente manera:
>
> ```
> # Credenciales de API de SIITEC 2
> SIITEC2_API_CLIENT_ID = ''
> SIITEC2_API_CLIENT_SECRET = ''
> ```

> **NOTA**
> Los valores de los parámetros `` y `` son proporcionados por el Departamento de Centro de Cómputo del Instituto Tecnológico de Colima.

Inicio de sesión
----------------

[](#inicio-de-sesión)

Una de las funcionalidades especiales de la libería API de SIITEC 2 es permitir acceso a recursos propios de cada usuario, identificándolo mediante su inicio de sesión.

El inicio de sesión en la API de SIITEC 2 se realiza utilizando el Framework de Autorización OAuth 2.0, el cual permite obtener acceso a recursos protegidos utilizando claves temporales de acceso, llamadas Access Token, y permitiendo una operación continua.

Estos procesos de inicio de sesión requieren de una compleja red de interacciones e intercambio de peticiones HTTP entre el Cliente (aplicación) y el servidor de SIITEC 2. Ese complejo mecanismo se simplifica utilizando funciones de la librería, que permiten centrarse menos en la estructura y más en la funcionalidad.

### Ejemplos de uso

[](#ejemplos-de-uso)

#### LLamado al inicio de sesión.

[](#llamado-al-inicio-de-sesión)

Para iniciar sesión se requiere tener un archivo o función disparadora de la acción. En el siguiente código se muestra cómo hacer una petición para inicio de sesión a SIITEC 2.

```