Creating Integrations Plugin in Mautic - Managing third-party Authentications in Mautic Plugin for Integrations

ApiConsumer.php

class ApiConsumer
{
    // Other variables, methods declaration.
    // Full code: https://github.com/mohit-rocks/HelloWorldBundle/blob/master/Connection/ApiConsumer.php
    /**
     * Fetch the data from API endpoint.
     */
    public function getSubscribers()
    {
        $users = $this->client->get('v2/api/fetch-dummy-users');
        // Polish and manipulate the data.
        return $users;
    }
}

Client.php

// Few methods from client.php
// Full code: https://github.com/mohit-rocks/HelloWorldBundle/blob/master/Connection/Client.php

/**
     * Get the client Client object from HttpFactory.
     */
    private function getClient(): ClientInterface
    {
        $this->getApiHost();
        $credentials = $this->getCredentials();
        return $this->httpFactory->getClient($credentials);
    }
    /**
     * Get the credentials object.
     */
    private function getCredentials(): Credentials
    {
        if (!$this->config->isConfigured()) {
            throw new PluginNotConfiguredException();
        }
        $apiKeys = $this->config->getApiKeys();
        return new Credentials($apiKeys['key'], $apiKeys['secret']);
    }

Config.php

// Let plugin system know about the class, add following snippet in Config.php
// Full code: https://github.com/mohit-rocks/HelloWorldBundle/blob/master/Config/config.php
  'services' => [
      'integrations' => [
          // Removed other services for better understanding.
          // Provides the form types to use for the configuration UI
          'mautic.integration.helloworld.configuration' => [
              'class'     => \MauticPlugin\HelloWorldBundle\Integration\Support\ConfigSupport::class,
              'tags'      => [
                  'mautic.config_integration',
              ],
          ],
      ],
  ],

Config.php - Change 2

// Full code: https://github.com/mohit-rocks/HelloWorldBundle/blob/master/Config/config.php
'helloworld.connection.client' => [
                'class'     => \MauticPlugin\HelloWorldBundle\Connection\Client::class,
                'arguments' => [
                    'mautic.integrations.auth_provider.basic_auth',
                    'mautic.helper.cache_storage',
                    'router',
                    'monolog.logger.mautic',
                    'helloworld.integration.config',
                ],
            ],

ConfigAuthType.php

// Full code: https://github.com/mohit-rocks/HelloWorldBundle/blob/master/Form/Type/ConfigAuthType.php
class ConfigAuthType extends AbstractType
{
    /**
     * {@inheritdoc}
     */
    public function buildForm(FormBuilderInterface $builder, array $options): void
    {
        $builder->add(
          'key',
          TextType::class,
          [
            'label'    => 'hello_world.form.key',
            'required' => true,
            'attr'     => [
              'class' => 'form-control',
            ],
            'constraints' => [
              new NotBlank(['message' => 'hello_world.form.key.required']),
            ],
          ]
        );
    }
}
 

ConfigSupport.php

class ConfigSupport extends HelloWorldIntegration implements ConfigFormInterface, ConfigFormAuthInterface
{
    use DefaultConfigFormTrait;

    /**
     * {@inheritdoc}
     */
    public function getAuthConfigFormName(): string
    {
        return ConfigAuthType::class;
    }
}

Credentials.php

// Full code: https://github.com/mohit-rocks/HelloWorldBundle/blob/master/Connection/Credentials.php
class Credentials implements CredentialsInterface
{
    private $userName;
    private $userPassword;

    public function __construct(string $userName, string $userPassword)
    {
        $this->userName     = $userName;
        $this->userPassword = $userPassword;
    }

    public function getUsername(): ?string
    {
        return $this->userName;
    }

    public function getPassword(): ?string
    {
        return $this->userPassword;
    }
}

HTTP Factory Call

/** @var $factory HttpFactory */
$client   = $factory->getClient($credentials);