Merge branch 'release/34.3.0'

in2code-de · Feb 1, 2024 · 2e36252 · 2e36252
2 parents 136c3c4 + e644881
commit 2e36252
Show file tree

Hide file tree

Showing 13 changed files with 103 additions and 13 deletions.
diff --git a/.project/docker/docker-compose.darwin.yml b/.project/docker/docker-compose.darwin.yml
@@ -56,3 +56,4 @@ services:
 
 volumes:
   mysql:
+  typo3var:
diff --git a/Classes/Domain/Model/Download.php b/Classes/Domain/Model/Download.php
@@ -78,7 +78,13 @@ public function getDomain(): string
         return $this->domain;
     }
 
-    public function setDomain(): self
+    public function setDomain(string $domain): self
+    {
+        $this->domain = $domain;
+        return $this;
+    }
+
+    public function setDomainAutomatically(): self
     {
         $this->domain = FrontendUtility::getCurrentDomain();
         return $this;

diff --git a/Classes/Domain/Model/Log.php b/Classes/Domain/Model/Log.php
@@ -41,9 +41,10 @@ class Log extends AbstractModel
     const STATUS_UTM_TRACK = 300;
     const STATUS_WIREDMINDS_CONNECTION = 400;
     const STATUS_WIREDMINDS_SUCCESSFUL = 410;
+    const STATUS_API_CREATEVISITOR = 500;
     const STATUS_ERROR = 900;
 
-    protected int $status = 0;
+    protected int $status = self::STATUS_DEFAULT;
 
     protected ?Visitor $visitor = null;
     protected ?DateTime $crdate = null;

diff --git a/Classes/Domain/Model/Newsvisit.php b/Classes/Domain/Model/Newsvisit.php
@@ -97,7 +97,13 @@ public function getDomain(): string
         return $this->domain;
     }
 
-    public function setDomain(): self
+    public function setDomain(string $domain): self
+    {
+        $this->domain = $domain;
+        return $this;
+    }
+
+    public function setDomainAutomatically(): self
     {
         $this->domain = FrontendUtility::getCurrentDomain();
         return $this;

diff --git a/Classes/Domain/Model/Pagevisit.php b/Classes/Domain/Model/Pagevisit.php
@@ -126,7 +126,13 @@ public function getDomain(): string
         return $this->domain;
     }
 
-    public function setDomain(): self
+    public function setDomain(string $domain): self
+    {
+        $this->domain = $domain;
+        return $this;
+    }
+
+    public function setDomainAutomatically(): self
     {
         $this->domain = FrontendUtility::getCurrentDomain();
         return $this;

diff --git a/Classes/Domain/Tracker/DownloadTracker.php b/Classes/Domain/Tracker/DownloadTracker.php
@@ -66,7 +66,8 @@ protected function getAndPersistNewDownload(string $href, int $pageIdentifier):
         $downloadRepository = GeneralUtility::makeInstance(DownloadRepository::class);
         $pageRepository = GeneralUtility::makeInstance(PageRepository::class);
         $page = $pageRepository->findByIdentifier($pageIdentifier);
-        $download = GeneralUtility::makeInstance(Download::class)->setHref($href)->setPage($page)->setDomain();
+        $download = GeneralUtility::makeInstance(Download::class)
+            ->setHref($href)->setPage($page)->setDomainAutomatically();
         if ($file !== null) {
             $download->setFile($file);
         }

diff --git a/Classes/Domain/Tracker/NewsTracker.php b/Classes/Domain/Tracker/NewsTracker.php
@@ -75,7 +75,7 @@ protected function getNewsvisit(
         $newsvisit
             ->setNews($news)
             ->setLanguage($languageUid)
-            ->setDomain()
+            ->setDomainAutomatically()
             ->setVisitor($visitor)
             ->setPagevisit($pagevisit);
         return $newsvisit;

diff --git a/Classes/Domain/Tracker/PageTracker.php b/Classes/Domain/Tracker/PageTracker.php
@@ -72,7 +72,7 @@ protected function getPageVisit(int $pageUid, int $languageUid, string $referrer
             ->setPage($page)
             ->setLanguage($languageUid)
             ->setReferrer($referrer)
-            ->setDomain()
+            ->setDomainAutomatically()
             ->setVisitor($visitor);
         return $pageVisit;
     }

diff --git a/Documentation/Technical/API/Index.md b/Documentation/Technical/API/Index.md
@@ -3,11 +3,11 @@
 
 # API and Interface from LUX (only in luxenterprise)
 
-Since luxenterprise 19.0.0 we introduced a proper interface with reading access as you may know from other REST APIs.
+Since LUXenterprise 19.0.0 we introduced a proper interface with reading access as you may know from other REST APIs.
 
 ## Configuration
 
-First of all you have to check the extension manager configuration of luxenterprise, to turn on the API and to add
+First of all you have to check the extension manager configuration of LUXenterprise, to turn on the API and to add
 an Api-Key and to define which IP-addresses are allowed to read from the API (optional)
 
 | Title             | Default value | Description                                                                                                                        |
@@ -16,12 +16,12 @@ an Api-Key and to define which IP-addresses are allowed to read from the API (op
 | apiKey            | -             | You have to enter a random value that will be used then as API-KEY for authentication. Note: Minimum 128 characters are needed!    |
 | apiKeyIpAllowList | -             | Define one or more IPs or ranges (optional) for allowing to read the API (e.g. 192.0.0.1,192.168.0.0/24,fc00::,2001:db8::567:89ab) |
 
-**Note:** Take care to add the typenum `1650897821` to your siteconfiguration (see FAQ for more details). In our example `leadapi.json` will be recognized from TYPO3 routing (see CURL examples below).
+**Note:** Take care to add the typenum `1650897821` to your siteconfiguration (see FAQ for more details). In our example `luxenterprise_api.json` will be recognized from TYPO3 routing (see CURL examples below).
 
 ## Endpoints
 
-The API works as most interfaces by selecting an endpoint and passing arguments as JSON. The result is also a JSON
-output.
+The API works as most interfaces by selecting an endpoint and passing arguments as JSON. The result is also always a
+JSON output.
 
 ### 1. Endpoint "findAllByAnyProperties" for getting a list of visitors (reading access)
 
@@ -334,3 +334,64 @@ You can also change the property field. E.g. if you want to search for an email:
   "propertyValue": "[email protected]"
 }
 ```
+
+
+
+### 3. Endpoint "create" to write new leads into database (writing access)
+
+*Note:* This endpoint was introduced with LUXenterprise 38.0.0 and is not available before this version
+
+The endpoint `create` can be used to add new visitor objects to LUX.
+
+*Note:* If you pass an email address and there is already a visitor with same mail existing, both visitor objects are
+going to be merged to keep history
+
+
+#### Example usage
+
+A new lead with two attributes is created from API with one pagevisit and with a fingerprint record can be added via
+API with these arguments:
+
+```
+{
+  "endpoint": "create",
+  "properties": {
+    "visitor": {
+      "email": "[email protected]",
+      "ipAddress": "127.0.0.1",
+      "identified": "1",
+      "scoring": "10",
+      "attributes": {
+        "0": {
+          "name": "firstname",
+          "value": "Alex"
+        },
+        "1": {
+          "name": "lastname",
+          "value": "Kellner"
+        }
+      },
+      "pagevisits": {
+        "0": {
+          "page": "12",
+          "language": "0",
+          "referrer": "https://lastdomain.org/page"
+        }
+      },
+      "fingerprints": {
+        "0": {
+          "value": "abcdef123456789foobar",
+          "domain": "https://mydomain.org",
+          "userAgent": "Mozilla/5.0"
+        }
+      }
+    }
+  }
+}
+```
+
+CURL example:
+
+```
+curl -k -d 'tx_luxenterprise_api[arguments]={"endpoint":"createVisitor","properties":{"visitor":{"email":"[email protected]","ipAddress":"127.0.0.1","identified":"1","scoring":"10","attributes":{"0":{"name":"firstname","value":"Alex"},"1":{"name":"lastname","value":"Kellner"}},"pagevisits":{"0":{"page":"12","language":"0","referrer":"https://lastdomain.org/page"}},"fingerprints":{"0":{"value":"abcdef123456789foobar","domain":"https://mydomain.org","userAgent":"Mozilla/5.0"}}}}}' -H 'Api-Key: abc...' --url https://www.in2code.de/luxenterprise_api.json
+```
diff --git a/Documentation/Technical/Changelog/Index.md b/Documentation/Technical/Changelog/Index.md
@@ -27,6 +27,7 @@ Double check if you have cleared all caches after installing a new LUX version t
 
 | Version    | Date       | State    | TYPO3          | Description                                                                                                                                                                                           |
 |------------|------------|----------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| 34.3.0     | 2024-02-01 | Featrue  | `11.5 + 12.4`  | Preparations for writing API in LUXenterprise                                                                                                                                                         |
 | 34.2.0     | 2024-01-25 | Featrue  | `11.5 + 12.4`  | Support MTM-Parameters in addition to UTM-Parameters now                                                                                                                                              |
 | 34.1.0     | 2024-01-16 | Task     | `11.5 + 12.4`  | Small style bugfix in summary mails, update documentation                                                                                                                                             |
 | 34.0.3     | 2023-11-21 | Bugfix   | `11.5 + 12.4`  | Prevent db compare error in UTM table                                                                                                                                                                 |

diff --git a/Resources/Private/Language/de.locallang_db.xlf b/Resources/Private/Language/de.locallang_db.xlf
@@ -1119,6 +1119,10 @@
 				<source>Successfully converted company to lead via Wiredminds</source>
 				<target state="translated">Firma erfolgreich ermittelt mittels Wiredminds</target>
 			</trans-unit>
+			<trans-unit id="module.analysis.log.status.500">
+				<source>Created new lead via API</source>
+				<target state="translated">Lead über API erstellt</target>
+			</trans-unit>
 			<trans-unit id="module.analysis.map">
 				<source>Lead source</source>
 				<target state="translated">Lead Ursprung</target>

diff --git a/Resources/Private/Language/locallang_db.xlf b/Resources/Private/Language/locallang_db.xlf
@@ -846,6 +846,9 @@
 			<trans-unit id="module.analysis.log.status.410">
 				<source>Successfully converted company to lead via Wiredminds</source>
 			</trans-unit>
+			<trans-unit id="module.analysis.log.status.500">
+				<source>Created new lead via API</source>
+			</trans-unit>
 			<trans-unit id="module.analysis.map">
 				<source>Lead source</source>
 			</trans-unit>

diff --git a/ext_emconf.php b/ext_emconf.php
@@ -4,7 +4,7 @@
     'description' => 'Living User Experience - LUX - the Marketing Automation tool for TYPO3.
         Turn your visitors to leads. Identification and profiling of your visitors within your TYPO3 website.',
     'category' => 'plugin',
-    'version' => '34.2.0',
+    'version' => '34.3.0',
     'author' => 'Alex Kellner',
     'author_email' => '[email protected]',
     'author_company' => 'in2code.de',