Download the PHP package itcolima/siitec2-api-client without Composer

On this page you can find all versions of the php package itcolima/siitec2-api-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of itcolima/siitec2-api-client

Informations about the package siitec2-api-client

Cliente PHP de la API de SIITEC 2

Instalación

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

Inicialización

La forma de inicializar la API de SIITEC 2 es mediante la clase ITColima\Siitec2\Api\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:

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

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

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.

Variaciones El código anterior está planteado para una aplicación que utilice PHP puro, sin un framework o libería adicional que soporte funcionalidades básicas. A continuación se describen algunas de las variaciones comunes para el código:

  • Es posible que el framework haga la carga automática del autoloader de composer.

  • La redirección puede cambiar dependiendo del framework, a continuación se incluyen algunos ejemplos con un framework distinto:

    • CodeIgniter 3

    • CodeIgniter 4

    Se requiere instalar el paquete francerz/utils para utilizar Francerz\Utils\Frameworks\CodeIgniter4.

Manejo de respuesta del inicio de sesión

Una vez iniciada la acción el servidor solicitará la autorización de acceso al usuario y cuando se obtenga un resultado, este será devuelto a la URI manejadora del inicio de sesión.

Acceso a los datos del usuario identificado

Uno de los comportamientos básicos esperados al iniciar sesión es identificar al usuario que haya ingresado al sistema. Para acceder a estos datos, la API de manera automática hace la recuperación desde el servidor y los almacena temporalmente durante la sesión.

DEPURACIÓN

De manera predeterminada la API tiene asociadas direcciones de inicialización, mismas que pueden modificarse para depuración y ejecución con entonos locales.

All versions of siitec2-api-client with dependencies

PHP Build Version
Package Version
Requires francerz/oauth2-client Version ^0.2
psr/http-client Version ^1.0
francerz/http Version ^0.3
francerz/api-client Version ^0.2
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package itcolima/siitec2-api-client contains the following files

Loading the files please wait ....