🏃‍♀️Uso Básico

Como manejar usar el SDK.

Conector

La clase principal del SDK es el SiiauConnector , la cual es responsable de enviar y autenticar nuestras peticiones a la API por nosotros. Existen tres formas de acceder a el:

Helper

Es la forma sugerida de uso, pues es la mas sencilla. Solo llamamos a la función siiau

siiau()->send(/** Request */);

Facade

Como una Facade de Laravel, puedes llamar a cualquier método de la clase de manera estatica.

use Siiau\ApiClient\Facades\Siiau;

Siiau::send( /** Request */ );

Injection

Puedes injectar el conector en cualquier método/constructor que el contenedor de Laravel resuelva. Por ejemplo, un controlador:

use Siiau\ApiClient\SiiauConnector;

final class RevisionController extends Controller
{
    public function show(SiiauConnector $siiau, Revision $revision): View
    {
        $siiau->send(/** Request */);
    }
}

La eleccion de cual método usar es totalmente del programador, pues su comportamiento es el mismo.

Consultar

Durante la documentacion encontraras dos maneras de usar el SDK para llamar a la API.

Basica / Resource

Esta forma es la mas comoda y se hace usando los metodos del mismo conector para consular la API.

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

Cuando uses esta forma, el SDK te devolvera siempre un DTO, que de menera simple, es una clase con valores.

El DTO podria ser un Error o el valor esperado. Por este motivo, siempre que se use este método, se recomienda checar si es una instancia de Error.

use Siiau\ApiClient\Objects\Error;

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

if ($usuario instanceof Error) {
    /** Handle API Error */
}

Avanzada / Request

La otra forma de hacer una peticion es usando las clases Request y enviarlas directamente con el método send del conector. Estas reciben los parametros necesarios en su constructor y, al enviarlas, se retorna una Response .

use Siiau\ApiClient\Requests\GetUsuarioRequest;

$response = siiau()->send(new GetUsuarioRequest(
    codigo: '123456789',
));

Este método es mas flexible pues nos da acceso a toda la información de la response. El SDK se basa en una libreria llamada Saloon y esta provee metodos conventientes para interactuar con las responses. Más sobre Saloon Responses.

// Obtiene el raw body.
$response->body();

// Obtiene el estatus
$response->status();

// Decodifica el cuerpo de formato JSON a un array de PHP.
$response->json()

// Nos da el DTO como si llamaramos el método desde el Resource. 
$response->dto();