(feat): implement API key general setting

Mike van den Hoek · Mike van den Hoek · commit 474e2e2b2f19 · 2023-06-21T11:32:09.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,12 +1,22 @@
 # Changelog
 
--   tested: WordPress 5.8.2
+-   tested: WordPress 6.2.2
+
+## v1.0.14
+
+### Feat
+
+-   Implement API key general setting.
+
+### Refactor
+
+-   gf-addon title and icon
 
 ## v1.0.13
 
 ### Refactor
 
--   Retrieve bsn by DigiD session instead of value of form field
+-   Retrieve bsn by DigiD session instead of value of form field.
 
 ## v1.0.12
 
diff --git a/languages/prefill-gravity-forms-nl_NL.mo b/languages/prefill-gravity-forms-nl_NL.mo
diff --git a/languages/prefill-gravity-forms-nl_NL.po b/languages/prefill-gravity-forms-nl_NL.po
@@ -14,27 +14,35 @@ msgstr "Basis URL"
 msgid "Certificates"
 msgstr "Certificaten"
 
-#: src/PrefillGravityForms/GravityForms/GravityFormsAddon.php:82
+#: src/PrefillGravityForms/GravityForms/GravityFormsAddon.php:88
+msgid "API key"
+msgstr "API sleutel"
+
+#: src/PrefillGravityForms/GravityForms/GravityFormsAddon.php:92
+msgid "API key is not always required. This depends on the supplier."
+msgstr "API sleutel is niet altijd vereist. Dit hangt af van de leverancier."
+
+#: src/PrefillGravityForms/GravityForms/GravityFormsAddon.php:100
 msgid "Certificates root location"
 msgstr "Certificaten hoofd locatie"
 
-#: src/PrefillGravityForms/GravityForms/GravityFormsAddon.php:90
+#: src/PrefillGravityForms/GravityForms/GravityFormsAddon.php:108
 msgid "Public certificate location"
 msgstr "Publieke locatie certificaten"
 
-#: src/PrefillGravityForms/GravityForms/GravityFormsAddon.php:97
+#: src/PrefillGravityForms/GravityForms/GravityFormsAddon.php:115
 msgid "Private certificate location"
 msgstr "Privé locatie certificaten"
 
-#: src/PrefillGravityForms/GravityForms/GravityFormsAddon.php:104
+#: src/PrefillGravityForms/GravityForms/GravityFormsAddon.php:122
 msgid "Passphrase"
 msgstr "Wachtwoord"
 
-#: src/PrefillGravityForms/GravityForms/GravityFormsAddon.php:109
+#: src/PrefillGravityForms/GravityForms/GravityFormsAddon.php:127
 msgid "Leave empty when a password is not required for the requests to the \"Haalcentraal\" API."
 msgstr "Dit veld mag leeg gelaten worden als er geen wachtwoord vereist is voor het maken van de verzoeken naar de \"Haalcentraal\" API."
 
-#: src/PrefillGravityForms/GravityForms/GravityFormsAddon.php:123
+#: src/PrefillGravityForms/GravityForms/GravityFormsAddon.php:141
 msgid "No certificate selected"
 msgstr "Geen certificaat geselecteerd"
 
diff --git a/languages/prefill-gravity-forms.pot b/languages/prefill-gravity-forms.pot
@@ -10,30 +10,38 @@ msgstr ""
 msgid "Base URL"
 msgstr ""
 
-#: src/PrefillGravityForms/GravityForms/GravityFormsAddon.php:79
+#: src/PrefillGravityForms/GravityForms/GravityFormsAddon.php:88
+msgid "API key"
+msgstr ""
+
+#: src/PrefillGravityForms/GravityForms/GravityFormsAddon.php:92
+msgid "API key is not always required. This depends on the supplier."
+msgstr ""
+
+#: src/PrefillGravityForms/GravityForms/GravityFormsAddon.php:97
 msgid "Certificates"
 msgstr ""
 
-#: src/PrefillGravityForms/GravityForms/GravityFormsAddon.php:82
+#: src/PrefillGravityForms/GravityForms/GravityFormsAddon.php:100
 msgid "Certificates root location"
 msgstr ""
 
-#: src/PrefillGravityForms/GravityForms/GravityFormsAddon.php:90
+#: src/PrefillGravityForms/GravityForms/GravityFormsAddon.php:108
 msgid "Public certificate location"
 msgstr ""
 
-#: src/PrefillGravityForms/GravityForms/GravityFormsAddon.php:97
+#: src/PrefillGravityForms/GravityForms/GravityFormsAddon.php:115
 msgid "Private certificate location"
 msgstr ""
 
-#: src/PrefillGravityForms/GravityForms/GravityFormsAddon.php:104
+#: src/PrefillGravityForms/GravityForms/GravityFormsAddon.php:122
 msgid "Passphrase"
 msgstr ""
 
-#: src/PrefillGravityForms/GravityForms/GravityFormsAddon.php:109
+#: src/PrefillGravityForms/GravityForms/GravityFormsAddon.php:127
 msgid "Leave empty when a password is not required for the requests to the \"Haalcentraal\" API."
 msgstr ""
 
-#: src/PrefillGravityForms/GravityForms/GravityFormsAddon.php:123
+#: src/PrefillGravityForms/GravityForms/GravityFormsAddon.php:141
 msgid "No certificate selected"
 msgstr ""
diff --git a/prefill-gravity-forms.php b/prefill-gravity-forms.php
@@ -4,7 +4,7 @@
  * Plugin Name:       Yard | BRP Prefill GravityForms
  * Plugin URI:        https://www.openwebconcept.nl/
  * Description:       Prefill GravityForms fields, based on the dutch BSN number. Retrieve personal information and place these values in the corrensponding fields.
- * Version:           1.0.13
+ * Version:           1.0.14
  * Author:            Yard | Digital Agency
  * Author URI:        https://www.yard.nl/
  * License:           GPL-3.0
@@ -20,7 +20,7 @@
     die;
 }
 
-define('PG_VERSION', '1.0.13');
+define('PG_VERSION', '1.0.14');
 define('PG_DIR', basename(__DIR__));
 define('PG_ROOT_PATH', __DIR__);
 define('PG_PLUGIN_SLUG', 'prefill-gravity-forms');
diff --git a/src/PrefillGravityForms/Controllers/BaseController.php b/src/PrefillGravityForms/Controllers/BaseController.php
@@ -175,6 +175,10 @@ protected function getCurlHeaders(string $doelBinding = ''): array
             'x-origin-oin: ' . $this->settings->getNumberOIN()
         ];
 
+        if (! empty($this->settings->getAPIKey())) {
+            $headers[] = 'x-opentunnel-api-key: ' . $this->settings->getAPIKey();
+        }
+
         return array_filter($headers);
     }
 
diff --git a/src/PrefillGravityForms/GravityForms/GravityFormsAddon.php b/src/PrefillGravityForms/GravityForms/GravityFormsAddon.php
@@ -84,6 +84,13 @@ public function plugin_settings_fields(): array
                         'name' => "{$prefix}base-url",
                         'required' => true,
                     ],
+                    [
+                        'label' => __('API key', 'prefill-gravity-forms'),
+                        'type' => 'text',
+                        'class' => 'medium',
+                        'name' => "{$prefix}api-key",
+                        'description' => __('API key is not always required. This depends on the supplier.', 'prefill-gravity-forms'),
+                    ],
                 ],
             ],
             [
diff --git a/src/PrefillGravityForms/GravityForms/GravityFormsSettings.php b/src/PrefillGravityForms/GravityForms/GravityFormsSettings.php
@@ -41,6 +41,11 @@ public function getNumberOIN(): string
         return $this->options[$this->prefix . 'oin-number'] ?? '';
     }
 
+    public function getAPIKey(): string
+    {
+        return $this->options[$this->prefix . 'api-key'] ?? '';
+    }
+
     public function getPublicCertificate(): string
     {
         return $this->options[$this->prefix . 'public-certificate'] ?? '';

Original file line number	Diff line number	Diff line change
`@@ -175,6 +175,10 @@ protected function getCurlHeaders(string $doelBinding = ''): array`
`175`	`175`	`'x-origin-oin: ' . $this->settings->getNumberOIN()`
`176`	`176`	`];`
`177`	`177`
	`178`	`+ if (! empty($this->settings->getAPIKey())) {`
	`179`	`+ $headers[] = 'x-opentunnel-api-key: ' . $this->settings->getAPIKey();`
	`180`	`+ }`
	`181`	`+`
`178`	`182`	`return array_filter($headers);`
`179`	`183`	`}`
`180`	`184`
Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,11 @@ public function getNumberOIN(): string`
`41`	`41`	`return $this->options[$this->prefix . 'oin-number'] ?? '';`
`42`	`42`	`}`
`43`	`43`
	`44`	`+ public function getAPIKey(): string`
	`45`	`+ {`
	`46`	`+ return $this->options[$this->prefix . 'api-key'] ?? '';`
	`47`	`+ }`
	`48`	`+`
`44`	`49`	`public function getPublicCertificate(): string`
`45`	`50`	`{`
`46`	`51`	`return $this->options[$this->prefix . 'public-certificate'] ?? '';`