aestrada2796/mrconnect

Integration with the Reseller MX API system

0.0.3 2023-04-30 14:50 UTC

Requires

• php: ^8.0
• ext-curl: *
• laravel/framework: ^10.9

Requires (Dev)

• phpunit/phpunit: ^9.6

MIT

• Adrian Estrada

• Integration API
• Reseller MX

README

MultiRumbo Connect

Instalación

Vendor

composer require aestrada2796/mrconnect

Servers

Entorno	Servidor
Test	http://localhost:8000/graphql

Importante

• Debe agregar a su archivo .env las siguiente variables:

API_USER='[e-mail]'
API_PASS='[e-mail]'
API_ROUTE=

El `API_ROUTE` es solo requerido si esta en entorno de Test 

Endpoints

• login
• topup
• topup-card
• parcel-service
• clapzi
• tracking

Uso

• La function del login no es necesario usarla pues el resto de las funciones verifican el token antes ejecutar la función.

Query::make("login")->login();

• En make ponemos el endpoint que se va a consultar Ej: Query::make("topup")
• Tenemos dos funciones para la consulta a los endpoint de GraphQL

1. Si tenemos un dominio avanzado de esta tecnología simplemente en la función ->query le pasamos la consulta, se pueden agregar tanta consultas como sean necesarias.

Query::make("")
    ->query('users(id: "5677f026-b5c6-474b-a927-6e90afd12d16"){ id,name }')
    ->send();

1. Este es más sencillo donde pasamos a la función ->function los paramentros necesarios, se pueden agregar tanta funciones como sean necesarias

Parámetro	Significado	Requerido
name	Nombre de la query a consultar	Si
fields	Campos a devolver por la consulta	Si
filters	Filtros de la consulta	No

Query::make("")
    ->function(
        'users',
        'id,name,roles{name}',
        'id: "15e2c1c9-ba99-468e-a008-547d0dc634c8"'
    )
    ->send();

• Se pueden usar tambien variables, pasándolas tipo arreglo a la function ->variables con formato ['key'=>'value''] y la utilizamos en la consulta agregando a la función ->name dos parámetros: el primero es el nombre y el segundo son las variables a usar, en formato ['$key'=>'value!''] donde $key es el nombre de la variable ya declarada iniciada con $ y value es el tipo de dato de la variable terminado en !. Dentro de la consulta se usa $key

Query::make("")
            ->name('prueba', ['$id' => "String!"])
            ->variables(["id" => "15e2c1c9-ba99-468e-a008-547d0dc634c8"])
            ->function(
                'users',
                'id,name,roles{name}',
                'id: $id'
            )
            ->send();