Updating Portal API filters. Fixing PHP code referens in code for Pay…

…ment API
Billmate · Jul 11, 2024 · a3610b5 · a3610b5
1 parent 75acc49
commit a3610b5
Show file tree

Hide file tree

Showing 40 changed files with 288 additions and 32 deletions.
diff --git a/Writerside/hi.tree b/Writerside/hi.tree
@@ -261,4 +261,7 @@
         <toc-element topic="PrestaShop.md"/>
         <toc-element topic="Magento.md"/>
     </toc-element>
+    <toc-element topic="API-Interaction.md">
+        <toc-element topic="API-Interaction-PHP.md"/>
+    </toc-element>
 </instance-profile>
diff --git a/Writerside/topics/API-Interaction-PHP.md b/Writerside/topics/API-Interaction-PHP.md
@@ -0,0 +1,3 @@
+# PHP
+
+Start typing here...
diff --git a/Writerside/topics/API-Interaction.md b/Writerside/topics/API-Interaction.md
@@ -0,0 +1,5 @@
+# API Interaction
+
+Since there are multiple APIs in the Qvickly ecosystem, it is important to understand how they interact with each other. In this section we will try to show examples of how the APIs can interact with each other.
+
+The examples is primarily divided into sections based in the language used to interact with the APIs.
diff --git a/Writerside/topics/Activate-payment.md b/Writerside/topics/Activate-payment.md
@@ -2,6 +2,8 @@
 
 <include from="Snippets-PaymentAPI.md" element-id="snippet-header"></include>
 
+This is the example for activatePayment. The documentation for can be found [here](activatePayment.md)
+
 <tabs>
   <tab title="%code-json%">
 <code-block lang="json">
@@ -53,7 +55,7 @@ print_r($payment);
 
 Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/activatePayment.php)
 
-Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class.
+<include from="Snippets-PHP-Module.md" element-id="snippet-composer-require" />
 
 </tab>
 

diff --git a/Writerside/topics/Add-payment.md b/Writerside/topics/Add-payment.md
@@ -2,6 +2,8 @@
 
 <include from="Snippets-PaymentAPI.md" element-id="snippet-header"></include>
 
+This is the example for addPayment. The documentation for can be found [here](addPayment.md)
+
 <tabs>
   <tab title="%code-json%">
 <code-block lang="json">
@@ -140,7 +142,7 @@ print_r($payment);
 
 Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/addPayment.php)
 
-Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class.
+<include from="Snippets-PHP-Module.md" element-id="snippet-composer-require" />
 
 </tab>
 

diff --git a/Writerside/topics/Auth-API-Changelog.md b/Writerside/topics/Auth-API-Changelog.md
@@ -2,4 +2,10 @@
 
 <include from="Snippets-AuthAPI.md" element-id="snippet-header" />
 
-Start typing here...
+## 2024-07-09
+
+Added examples for Auth API
+
+## 2024-07-08
+
+Basic information about the Auth API
diff --git a/Writerside/topics/Cancel-payment.md b/Writerside/topics/Cancel-payment.md
@@ -2,6 +2,8 @@
 
 <include from="Snippets-PaymentAPI.md" element-id="snippet-header"></include>
 
+This is the example for cancelPayment. The documentation for can be found [here](cancelPayment.md)
+
 <tabs>
     <tab title="%code-json%">
 <code-block lang="json">
@@ -53,7 +55,7 @@ print_r($payment);
 
 Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/cancelPayment.php)
 
-Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class.
+<include from="Snippets-PHP-Module.md" element-id="snippet-composer-require" />
 
 </tab>
 

diff --git a/Writerside/topics/Checkout-API-Changelog.md b/Writerside/topics/Checkout-API-Changelog.md
@@ -2,4 +2,4 @@
 
 <include from="Snippets-CheckoutAPI.md" element-id="snippet-header" />
 
-Start typing here...
+Not yet started
diff --git a/Writerside/topics/Create-invoice-from-order.md b/Writerside/topics/Create-invoice-from-order.md
@@ -2,6 +2,8 @@
 
 <include from="Snippets-PaymentAPI.md" element-id="snippet-header"></include>
 
+This is the example for createInvoiceFromOrderHash. The documentation for can be found [here](createInvoiceFromOrder.md)
+
 <tabs>
     <tab title="%code-json%">
 <code-block lang="json">
@@ -54,7 +56,7 @@ print_r($invoice);
 
 Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/createInvoiceFromOrderHash.php)
 
-Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class.
+<include from="Snippets-PHP-Module.md" element-id="snippet-composer-require" />
 
 </tab>
 

diff --git a/Writerside/topics/Crediflow-search-party.md b/Writerside/topics/Crediflow-search-party.md
@@ -2,6 +2,8 @@
 
 <include from="Snippets-PaymentAPI.md" element-id="snippet-header"></include>
 
+This is the example for crediflowSearchParty. The documentation for can be found [here](crediflowSearchParty.md)
+
 <tabs>
     <tab title="%code-json%">
 <code-block lang="json">
@@ -53,7 +55,7 @@ print_r($parties);
 
 Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/crediflowSearchParty.php)
 
-Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class.
+<include from="Snippets-PHP-Module.md" element-id="snippet-composer-require" />
 
 </tab>
 

diff --git a/Writerside/topics/Credit-payment.md b/Writerside/topics/Credit-payment.md
@@ -2,6 +2,8 @@
 
 <include from="Snippets-PaymentAPI.md" element-id="snippet-header"></include>
 
+This is the example for creditPayment. The documentation for can be found [here](creditPayment.md)
+
 <tabs>
   <tab title="%code-json%">
 
@@ -120,7 +122,7 @@ print_r($payment);
 
 Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/creditPayment.php)
 
-Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class.
+<include from="Snippets-PHP-Module.md" element-id="snippet-composer-require" />
 
 </tab>
 

diff --git a/Writerside/topics/Get-API-Credentials.md b/Writerside/topics/Get-API-Credentials.md
@@ -2,6 +2,8 @@
 
 <include from="Snippets-PaymentAPI.md" element-id="snippet-header"></include>
 
+This is the example for getAPICredentials. The documentation for can be found [here](getAPICredentials.md)
+
 <tabs>
     <tab title="%code-json%">
 <code-block lang="json">
@@ -55,7 +57,7 @@ print_r($credentials);
 
 Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/getAddress.php)
 
-Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class.
+<include from="Snippets-PHP-Module.md" element-id="snippet-composer-require" />
 
 </tab>
 

diff --git a/Writerside/topics/Get-account-info.md b/Writerside/topics/Get-account-info.md
@@ -2,6 +2,8 @@
 
 <include from="Snippets-PaymentAPI.md" element-id="snippet-header"></include>
 
+This is the example for getAccountinfo. The documentation for can be found [here](getAccountinfo.md)
+
 <tabs>
     <tab title="%code-json%">
 <code-block lang="JSON">
@@ -56,7 +58,7 @@ print_r($payment);
 
 Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/getAccountInfo.php)
 
-Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class.
+<include from="Snippets-PHP-Module.md" element-id="snippet-composer-require" />
 
 </tab>
 

diff --git a/Writerside/topics/Get-address.md b/Writerside/topics/Get-address.md
@@ -2,6 +2,8 @@
 
 <include from="Snippets-PaymentAPI.md" element-id="snippet-header"></include>
 
+This is the example for getAddress. The documentation for can be found [here](getAddress.md)
+
 <tabs>
   <tab title="%code-json%">
 <code-block lang="JSON">
@@ -55,7 +57,7 @@ print_r($address);
 
 Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/getAddress.php)
 
-Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class.
+<include from="Snippets-PHP-Module.md" element-id="snippet-composer-require" />
 
 </tab>
 

diff --git a/Writerside/topics/Get-customers-by-name.md b/Writerside/topics/Get-customers-by-name.md
@@ -2,6 +2,8 @@
 
 <include from="Snippets-PaymentAPI.md" element-id="snippet-header"></include>
 
+This is the example for getCustomersByName. The documentation for can be found [here](getCustomersByName.md)
+
 <tabs>
     <tab title="%code-json%">
 <code-block lang="json">
@@ -53,7 +55,7 @@ print_r($customers);
 
 Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/getCustomersByName.php)
 
-Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class.
+<include from="Snippets-PHP-Module.md" element-id="snippet-composer-require" />
 
 </tab>
 

diff --git a/Writerside/topics/Get-due-payments.md b/Writerside/topics/Get-due-payments.md
@@ -2,6 +2,8 @@
 
 <include from="Snippets-PaymentAPI.md" element-id="snippet-header"></include>
 
+This is the example for getDuePayments. The documentation for can be found [here](getDuePayments.md)
+
 <tabs>
     <tab title="%code-json%">
 <code-block lang="json">
@@ -48,7 +50,7 @@ print_r($payments);
 
 Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/getDuePayments.php)
 
-Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class.
+<include from="Snippets-PHP-Module.md" element-id="snippet-composer-require" />
 
 </tab>
 

diff --git a/Writerside/topics/Get-exchange-rate.md b/Writerside/topics/Get-exchange-rate.md
@@ -2,6 +2,8 @@
 
 <include from="Snippets-PaymentAPI.md" element-id="snippet-header"></include>
 
+This is the example for getExchangeRate. The documentation for can be found [here](getExchangeRate.md)
+
 <tabs>
     <tab title="%code-json%">
 <code-block lang="json">
@@ -55,7 +57,7 @@ print_r($rate);
 
 Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/getExchangeRate.php)
 
-Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class.
+<include from="Snippets-PHP-Module.md" element-id="snippet-composer-require" />
 
 </tab>
 

diff --git a/Writerside/topics/Get-fees.md b/Writerside/topics/Get-fees.md
@@ -2,6 +2,8 @@
 
 <include from="Snippets-PaymentAPI.md" element-id="snippet-header"></include>
 
+This is the example for getFees. The documentation for can be found [here](getFees.md)
+
 <tabs>
     <tab title="%code-json%">
 <code-block lang="json">
@@ -48,7 +50,7 @@ print_r($fees);
 
 Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/getFees.php)
 
-Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class.
+<include from="Snippets-PHP-Module.md" element-id="snippet-composer-require" />
 
 </tab>
 

diff --git a/Writerside/topics/Get-invoice-by-hash.md b/Writerside/topics/Get-invoice-by-hash.md
@@ -2,6 +2,8 @@
 
 <include from="Snippets-PaymentAPI.md" element-id="snippet-header"></include>
 
+This is the example for getInvoiceByHash. The documentation for can be found [here](getInvoiceByHash.md)
+
 <tabs>
     <tab title="%code-json%">
 <code-block lang="json">
@@ -53,7 +55,7 @@ print_r($invoice);
 
 Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/getInvoiceByHash.php)
 
-Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class.
+<include from="Snippets-PHP-Module.md" element-id="snippet-composer-require" />
 
 </tab>
 

diff --git a/Writerside/topics/Get-invoices-by-customer.md b/Writerside/topics/Get-invoices-by-customer.md
@@ -2,6 +2,8 @@
 
 <include from="Snippets-PaymentAPI.md" element-id="snippet-header"></include>
 
+This is the example for getInvoicesByCustomer. The documentation for can be found [here](getInvoicesByCustomer.md)
+
 <tabs>
     <tab title="%code-json%">
 <code-block lang="json">
@@ -53,7 +55,7 @@ print_r($invoices);
 
 Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/getInvoicesByCustomer.php)
 
-Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class.
+<include from="Snippets-PHP-Module.md" element-id="snippet-composer-require" />
 
 </tab>
 

diff --git a/Writerside/topics/Get-invoices-by-pno.md b/Writerside/topics/Get-invoices-by-pno.md
@@ -2,6 +2,8 @@
 
 <include from="Snippets-PaymentAPI.md" element-id="snippet-header"></include>
 
+This is the example for getInvoicesByPno. The documentation for can be found [here](getInvoicesByPno.md)
+
 <tabs>
     <tab title="%code-json%">
 <code-block lang="json">
@@ -55,7 +57,7 @@ print_r($invoices);
 
 Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/getInvoicesByPno.php)
 
-Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class.
+<include from="Snippets-PHP-Module.md" element-id="snippet-composer-require" />
 
 </tab>
 

diff --git a/Writerside/topics/Get-merchant-by-orgnum.md b/Writerside/topics/Get-merchant-by-orgnum.md
@@ -2,6 +2,8 @@
 
 <include from="Snippets-PaymentAPI.md" element-id="snippet-header"></include>
 
+This is the example for getMerchantByOrgnum. The documentation for can be found [here](getMerchantByOrgnum.md)
+
 <tabs>
     <tab title="%code-json%">
 <code-block lang="json">
@@ -53,7 +55,7 @@ print_r($merchant);
 
 Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/getMerchantByOrgnum.php)
 
-Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class.
+<include from="Snippets-PHP-Module.md" element-id="snippet-composer-require" />
 
 </tab>
 

diff --git a/Writerside/topics/Get-order-by-hash.md b/Writerside/topics/Get-order-by-hash.md
@@ -2,6 +2,8 @@
 
 <include from="Snippets-PaymentAPI.md" element-id="snippet-header"></include>
 
+This is the example for getOrderByHash. The documentation for can be found [here](getOrderByHash.md)
+
 <tabs>
     <tab title="%code-json%">
 <code-block lang="json">
@@ -53,7 +55,7 @@ print_r($order);
 
 Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/getOrderByHash.php)
 
-Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class.
+<include from="Snippets-PHP-Module.md" element-id="snippet-composer-require" />
 
 </tab>
 

diff --git a/Writerside/topics/Get-order-info.md b/Writerside/topics/Get-order-info.md
@@ -2,6 +2,8 @@
 
 <include from="Snippets-PaymentAPI.md" element-id="snippet-header"></include>
 
+This is the example for getOrderInfo. The documentation for can be found [here](getOrderInfo.md)
+
 <tabs>
     <tab title="%code-json%">
 <code-block lang="json">
@@ -53,7 +55,7 @@ print_r($order);
 
 Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/getOrderInfo.php)
 
-Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class.
+<include from="Snippets-PHP-Module.md" element-id="snippet-composer-require" />
 
 </tab>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,4 +2,4 @@

		<include from="Snippets-CheckoutAPI.md" element-id="snippet-header" />

		Start typing here...
		Not yet started