1.1.7 Check API key before creating a shipment

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "myparcelnl/sdk",
-    "version": "v1.1.6",
+    "version": "v1.1.7",
     "description": "This package is designed to send and receive data from MyParcel by means of an API.",
     "homepage": "https://www.myparcel.nl",
     "tags": ["MyParcel", "My Parcel", "Post NL", "PostNL"],

src/AutoLoader.php

@@ -1,6 +1,7 @@
 <?php
 include_once ('Helper/MyParcelCollection.php');
 include_once ('Helper/MyParcelCurl.php');
+include_once ('Services/CheckApiKeyService.php');
 include_once ('Model/MyParcelRequest.php');
 include_once ('Model/MyParcelClassConstants.php');
 include_once ('Model/MyParcelConsignment.php');

src/Model/MyParcelRequest.php

@@ -26,7 +26,7 @@ class MyParcelRequest
     /**
      * Supported request types.
      */
-    const REQUEST_TYPE_CREATE_CONSIGNMENT   = 'shipments';
+    const REQUEST_TYPE_SHIPMENTS   = 'shipments';
     const REQUEST_TYPE_RETRIEVE_LABEL       = 'shipment_labels';
 
     /**
@@ -98,7 +98,7 @@ public function setRequestParameters($apiKey, $body = '', $requestHeader = '')
      * @return MyParcelRequest|array|false|string
      * @throws \Exception
      */
-    public function sendRequest($method = 'POST', $uri = self::REQUEST_TYPE_CREATE_CONSIGNMENT)
+    public function sendRequest($method = 'POST', $uri = self::REQUEST_TYPE_SHIPMENTS)
     {
         if (!$this->checkConfigForRequest()) {
             return false;
@@ -198,7 +198,6 @@ public function sendRequest($method = 'POST', $uri = self::REQUEST_TYPE_CREATE_C
         $request->close();
 
         if ($this->getError()) {
-            throw new \Exception('Error in MyParcel API request: ' . $this->getError() . '. Url: ' . $url . ' Request: ' . $this->body);
         }
 
         return $this;

src/Services/CheckApiKeyService.php

@@ -0,0 +1,67 @@
+<?php
+/**
+ * A services to check if the API-key is correct
+ *
+ * If you want to add improvements, please create a fork in our GitHub:
+ * https://github.com/myparcelnl
+ *
+ * @author      Reindert Vetter <[email protected]>
+ * @copyright   2010-2017 MyParcel
+ * @license     http://creativecommons.org/licenses/by-nc-nd/3.0/nl/deed.en_US  CC BY-NC-ND 3.0 NL
+ * @link        https://github.com/myparcelnl/sdk
+ * @since       File available since Release v1.1.7
+ */
+
+namespace MyParcelNL\Sdk\src\Services;
+
+use MyParcelNL\Sdk\src\Model\MyParcelRequest;
+
+class CheckApiKeyService
+{
+    private $api_key;
+
+    /**
+     * @return mixed
+     */
+    public function getApiKey()
+    {
+        return $this->api_key;
+    }
+
+    /**
+     * @param mixed $api_key
+     */
+    public function setApiKey($api_key)
+    {
+        $this->api_key = $api_key;
+
+        return $this;
+    }
+
+    public function apiKeyIsCorrect()
+    {
+        try {
+            $request = (new MyParcelRequest());
+
+            $userAgent = $request->getUserAgentFromComposer();
+            $request
+                ->setUserAgent($userAgent)
+                ->setRequestParameters(
+                    $this->getApiKey(),
+                    '',
+                    MyParcelRequest::REQUEST_HEADER_RETRIEVE_SHIPMENT
+                )
+                ->sendRequest('GET');
+
+            if ($request->getResult() === null) {
+                throw new \Exception('Unable to connect to MyParcel.');
+            }
+        } catch (\Exception $exception) {
+            if (strpos($exception, 'Access Denied') > 1) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+}