ACCEDE (Tercers, Vialer i Firmadoc) Client for Laravel 5.6

Paquet d'accés al WS de Accede (Aytos) per a Tercers i Vialer

Instalació

composer require ajtarragona/accede-client:"@dev"

Configuració

Pots configurar el paquet a través de l'arxiu .env de l'aplicació. Aquests son els parámetres disponibles :

ACCEDE_TOKEN_KEY 
ACCEDE_WS_URL 
ACCEDE_USER 
ACCEDE_PASSWORD 
ACCEDE_CLIENT 
ACCEDE_ENTITY 
ACCEDE_ORGANISM 

Alternativament, pots publicar l'arxiu de configuració del paquet amb la comanda:

php artisan vendor:publish --tag=ajtarragona-accede-config

Això copiarà l'arxiu a config/accede.php.

Publicar configuració Laroute

php artisan vendor:publish --provider='Lord\Laroute\LarouteServiceProvider'

posar rutes absolutes a app/config/laroute.php

Publicar scripts laroute cada vegada que canviem una ruta

php artisan laroute:generate

Ús

Un cop configurat, el paquet està a punt per fer-se servir.

Ho pots fer de les següents maneres:

A través d'una Facade:

use AccedeTercers;
use AccedeVialer;
use Firmadoc;
...
public function test(){
	$tercer=AccedeTercers::getTercerById(123456);
	$vies=AccedeVialer::getAllVies();
	$tipusdoc=Firmadoc::getTipusDocument(1234);
	...
}

En aquest cas, per facilitar-ne l'ús, es pot registrar l'alias de la Facade a l'arxiu config/app.php :

'aliases' => [
	...
	'AccedeTercers' => Ajtarragona\Accede\Facades\AccedeTercers::class,
	'AccedeVialer' => Ajtarragona\Accede\Facades\AccedeVialer::class,
	'Firmadoc' => Ajtarragona\Accede\Facades\Firmadoc::class
]

Vía Injecció de dependències:

Als teus controlladors, helpers, model:

use Ajtarragona\Accede\Models\AccedeTercersProvider;
use Ajtarragona\Accede\Models\AccedeVialerProvider;
use Ajtarragona\Accede\Models\FirmadocProvider;
...
public function test(AccedeTercersProvider $accedetercers, AccedeVialerProvider $accedevialer){
	$tercer=$accedetercers->getTercerById(123456);
	$vies=$accedevialer->getAllVies();
	$tipusdoc=Firmadoc::getTipusDocument(1234);
	...
}

Vía funció helper:

...
public function test(){
	$tercer=accedetercers()->getTercerById(123456);
	$vies=accedevialer()->getAllVies();
	$tipusdoc=firmadoc()->getTipusDocument(1234);
	...
}

Funcions

AccedeTercers

Funció	Paràmetres	Retorn
getTercerById	id: codi del tercer	Un objecte Tercer
searchTercersByName	name: que contingui el nom del tercer	Un array d'objectes Tercer
searchTercersBySurname1	surname: que contingui el primer cognom del tercer	Un array d'objectes Tercer
searchTercersBySurname2	surname: que contingui el segon cognom del tercer	Un array d'objectes Tercer
searchTercersBySurnames	surname1: que contingui el primer cognom del tercer surname2: que contingui el segon cognom del tercer	Un array d'objectes Tercer
searchTercersByParts	filter: agafa les parts de l'string passat (separat per espais) i busca a nom i a cognoms i interseca	Un array d'objectes Tercer
searchTercersByFullName	filter: que es contingui a nom o cognoms	Un array d'objectes Tercer
getTercerByPasaporte	pasaporte: que el passaport sigui igual	Un array d'objectes Tercer
getTercerByTarjetaResidencia	tresidencia: que la tarjeta sigui igual	Un array d'objectes Tercer
getTercerByCIF	cif: que el cif sigui igual	Un array d'objectes Tercer
getTercerByDNI	dni: que el dni sigui igual	Un array d'objectes Tercer
getTercerByNIF	nif: que el cif sigui igual	Un array d'objectes Tercer
getDomicilisTercer	id: codi del tercer	Array d'objectes Domicili
createTercer	tercer: objecte tercer	boolea
updateTercer	tercer: objecte tercer	boolea
deleteTercer	id: codi del tercer	boolea

En tots els casos es retorna una excepció si falla o no es troba res.

AccedeVialer

Funció	Paràmetres	Retorn
getPais	codigoPais	Un objecte Pais
getAllPaisos		Un array d'objectes Pais
searchPaisosByName	filter	Un array d'objectes Pais el nom dels quals sigui igual al filtre passat. És insensible a majúscules Busqueda exacta
getProvincia	codigoProvincia	Un objecte Provincia segons el codi passat
getAllProvincies		Un array d'objectes Provincia
searchProvinciesByName	filter	Un array d'objectes Provincia el nom dels quals sigui igual al filtre passat. És insensible a majúscules Busqueda exacta
getMunicipi	codigoMunicipio codigoProvincia=false
getAllMunicipis	codigoProvincia=false
searchMunicipisByName	filter codigoProvincia=false
getPortal	codigoPortal
getAllPortals
getPorta	codigoPuerta
getAllPortes
getPlanta	codigoPlanta
getAllPlantes
getEscala	codigoEscalera
getAllEscales
getAllBlocs	codiProvincia=false codiMunicipi=false
getBloc	codigoBloque
getAllCodisPostals	codiProvincia=false codiMunicipi=false
getCodiPostal	codigoPostal codiProvincia=false codiMunicipi=false
getCodisPostalsVia	codigoIneVia numero=false
getNumerosVia	codigoIneVia
getBlocsVia	codigoIneVia
getLletresVia	codigoIneVia numero=false
getPlantesVia	codigoIneVia numero=false
getEscalesVia	codigoIneVia numero=false
getPortesVia	codigoIneVia numero=false nombrePlanta=false
searchViesByName	filter codiProvincia=false codiMunicipi=false
getAllVies	codiProvincia=false codiMunicipi=false
getVia	codigoIneVia
getAllTipusVia
getTipusVia	codigoTipoVia
searchDomicilis	params=[]
getDomicilisByVia	codiVia numeroDesde=false numeroHasta=false

En tots els casos es retorna una excepció AccedeErrorException si falla o AccedeNoResultsException si no es troba res.

Firmadoc

Funció	Paràmetres	Retorn
createDocument	params=[]	Id del document

API Json

//Paisos

/ajtarragona/accede/api/paisos
/ajtarragona/accede/api/paisos/{codigoPais}

//Provincies
/ajtarragona/accede/api/provincies
/ajtarragona/accede/api/provincies/{codigoProvincia}

//Municipis
/ajtarragona/accede/api/provincies/{codigoProvincia}/municipis
/ajtarragona/accede/api/provincies/{codigoProvincia}/municipis/{codigoMunicipio}


//Vies
/ajtarragona/accede/api/provincies/{codigoProvincia}/municipis/{codigoMunicipio}/vies/search/{filter}
/ajtarragona/accede/api/provincies/{codigoProvincia}/municipis/{codigoMunicipio}/vies/combo
/ajtarragona/accede/api/provincies/{codigoProvincia}/municipis/{codigoMunicipio}/vies
/ajtarragona/accede/api/provincies/{codigoProvincia}/municipis/{codigoMunicipio}/vies/{codigoIneVia}


//Numeros de la via
/ajtarragona/accede/api/numeros/combo/{codigoIneVia}
/ajtarragona/accede/api/numeros/{codigoIneVia}

//Blocs de la via
/ajtarragona/accede/api/blocs/combo/{codigoIneVia}
/ajtarragona/accede/api/blocs/{codigoIneVia}

//Escales de la via
/ajtarragona/accede/api/escales/combo/{codigoIneVia}/{numero?}
/ajtarragona/accede/api/escales/{codigoIneVia}/{numero?}

//Lletres de la via
/ajtarragona/accede/api/lletres/combo/{codigoIneVia}/{numero?}
/ajtarragona/accede/api/lletres/{codigoIneVia}/{numero?}

//Plantes de la via
/ajtarragona/accede/api/plantes/combo/{codigoIneVia}/{numero?}
/ajtarragona/accede/api/plantes/{codigoIneVia}/{numero?}

//Codis postals de la via
/ajtarragona/accede/api/codispostals/combo/{codigoIneVia}/{numero?}
/ajtarragona/accede/api/codispostals/{codigoIneVia}/{numero?}

//Portes de la via
/ajtarragona/accede/api/portes/combo/{codigoIneVia}/{numero?}/{nombrePlanta?}
/ajtarragona/accede/api/portes/{codigoIneVia}/{numero?}/{nombrePlanta?}

Component Web

php artisan vendor:publish --tag=ajtarragona-accede-assets --force