SmartForm.cz Api Integration

SmartForm.cz API integration for Nette Framework inspirated by Contributte/GoSms

Content

Requirements
Installation - register an extension
Usage

Requirements

Create account on smartform.cz and copy clientId and password from https://admin.smartform.cz/wsUser/wsListYear.

Installation

extensions:
	smartForm: Awaitcz\SmartForm\DI\SmartFormExtension


smartForm:
	clientId: R3sZyjLPLP
	token: qLa1vcNn
	testMode: false # Optional, default false

Usage

We now have three clients ready for you: AddressClient, CompanyClient and EmailClient.

All methods throw ClientException with error message and code as response status when response status is not 200;

AddressClient

whisper() - Whisper address
validate() - Validate address

CompanyClient

whisper() - Whisper company
validate() - Validate company

EmailClient

validate() - Validate email

<?php

namespace App;

use Awaitcz\SmartForm\Client\AddressClient;
use Awaitcz\SmartForm\Client\CompanyClient;
use Awaitcz\SmartForm\Client\EmailClient;
use Awaitcz\SmartForm\Entity\Address\Validate\ValidateAddress;
use Awaitcz\SmartForm\Entity\Address\Whisper\Query\WhisperAddressByMunicipalityAndDistrict;
use Awaitcz\SmartForm\Entity\Address\Whisper\Query\WhisperAddressByStreetAndNumberMunicipalityPostCode;
use Awaitcz\SmartForm\Entity\Address\Whisper\Query\WhisperAddressByStreetNumberMunicipalityPostCode;
use Awaitcz\SmartForm\Entity\Address\Whisper\Query\WhisperAddressByWholeAddress;
use Awaitcz\SmartForm\Entity\Address\Whisper\WhisperAddress;
use Awaitcz\SmartForm\Entity\Company\Validate\ValidateCompany;
use Awaitcz\SmartForm\Entity\Company\Whisper\Query\WhisperCompanyByNameQuery;
use Awaitcz\SmartForm\Entity\Company\Whisper\WhisperCompany;
use Awaitcz\SmartForm\Entity\Country;
use Awaitcz\SmartForm\Entity\Email\Validate\ValidateEmail;
use Awaitcz\SmartForm\Exception\ClientException;


final class ExampleService
{

	public function __construct(
		private readonly AddressClient $addressClient,
		private readonly CompanyClient $companyClient,
		private readonly EmailClient $emailClient,
	)
	{
	}

	public function tryWhisperAddress(): void
	{

		try {

			$whisperedAddressResponse = $this->addressClient->whisper(new WhisperAddress(
				new WhisperAddressByWholeAddress('Na Pavím vrchu 1949/2'),
				country: Country::CzechRepublic,
			));

			$addresses = $whisperedAddressResponse->getResult();

			foreach($addresses as $address) {
				dump([
					$address->wholeAddress, // Na Pavím vrchu 1949/2, 15000 Praha 5 - Smíchov
				]);
				break;
			}

		} catch (ClientException $e) {
			dump($e->getCode());
			dump($e->getMessage());
		}

	}

	public function tryValidateCompany(): void
	{

		try {

			$validatedCompanyResponse = $this->companyClient->validate(
			  new ValidateCompany(registrationNumber: '75848015')
			);

			$companies = $whisperedAddressResponse->getResult();

			foreach($companies as $company) {
				dump([
					$company->registrationNumber, // 75848015
					$company->naceCodes, // 27900, 620
				]);
				break;
			}

		} catch (ClientException $e) {
			dump($e->getCode());
			dump($e->getMessage());
		}

	}

}

awaitcz/smartform