hypotheekbond/client

A client implementing the hypotheekbond API.

v2.0.1 2019-10-16 13:20 UTC

Requires

• ext-soap: *
• laravel/framework: ^6.0
• nesbot/carbon: ~1.0 | ~2.0

MIT

• Victor Preda
• Lucas van der Have

README

This is a package that consumes the hypotheekbond SOAP API for pushing customer data to their system and extracting important information in form of signals.

Implementation

Implement your own version of the MortgageUnionConfig and bind it to the contract.

Publish

There is an example config file that can be published with :

php artisan vendor:publish --provider='MortgageUnion\ServiceProvider' --tag='config'

This config contains advisor and partner credentials.

Advisor credentials

The advisor credentials are the login credentials of the user's account on the hypotheekbond.nl website. These credentials are used to keep track of which user has created a customer.

Partner credentials

The partner credentials are your api username and key. These credentials need to be requested at hypotheekbond. Requests can be sent to [e-mail].

Examples

Example push usage:

$customer = new \MortgageUnion\Models\Customer([
    'name' => 'Vries',
    'suffix' => 'de',
    'initials' => 'A',
    'firstName' => 'Anton',
]);

$customerRepository = app()->make(MortgageUnion\Repositories\CustomerRepository::class);
$customerRepository->createOrUpdate($customer);

Example signal usage:

$signalRepository = app()->make(MortgageUnion\Repositories\SignalRepository::class)
$signalRepository->getSignals();

Example Config implementation:s config contains advisor and partner credentials.

class MortgageUnionConfig implements \MortgageUnion\Config\Contracts\MortgageUnionConfig
{
    /**
     * @var Repository
     */
    private $configRepository;

    /**
     * MortgageUnionConfig constructor.
     * @param Repository $configRepository
     */
    public function __construct(ConfigRepository $configRepository)
    {
        $this->configRepository = $configRepository;
    }

    public function getAdvisorUser()
    {
        return $this->configRepository->get('hypotheekbond_adviseur');
    }

    public function getAdvisorPassword()
    {
        return $this->configRepository->get('hypotheekbond_adviseurPassword');
    }
ingle 
    public function getPartnerUser()
    {
        return $this->configRepository->get('hypotheekbond.partner');
    }
    
    public function getPartnerPassword()
    {
        return $this->configRepository->get('hypotheekbond.partnerPassword');
    }

    public function getURI()
    {
        return $this->configRepository->get('hypotheekbond.uri');
    }
    
    public function getWSDL()
    {
        return $this->configRepository->get('hypotheekbond.wsdl');
    }
}

Example login implementation:

public function controllerMethodHypotheekbondLogin(\MortgageUnion\Repositories\AuthRepository $authRepository)
{
    $result = $authRepository->singleClickLogin();

    if ($result instanceof SoapFault) {
        return abort(500, "Could not authenticate");
    }

    return redirect()->to($result);
}