User Tools

Site Tools

You are here: start » pvs » integrate_customdevkit
pvs:integrate_customdevkit

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
pvs:integrate_customdevkit [2016/03/03 16:02]
rsk [Example] 		pvs:integrate_customdevkit [2020/03/22 09:15] (current)
rsk [Example]
Line 8: Line 8:
   * Knowledge of PHP   * Knowledge of PHP
  
-===== Requirements =====+===== Please Remember =====
  
-  * API access credentials for the 3rd party SMS/API gateway +  * <php>$phone</php> variable will be automatically supplied, and contains the customer's phone number 
-  * Knowledge of PHP+  * <php>$code</php>  variable will be automatically supplied, and contains a 4 digit code
  
 +===== The Steps =====
 +
 +  * open customdevkit.php file (which can be found in the Layer's PVS Module folder)
 +  * provide the API credentials in the script, this depends on the Gateway provider. Some call them username/passwords, while others give them different names
 +  * provide the content of the SMS message in the <php>$body</php> variable, remember to include the <php>$code</php> variable in your message, as that is the code to be sent to the customer
 +  * build & execute the api request (have a look at example files from your gateway provider)
 +  * log the API Request attempt to help troubleshoot
 ===== Example ===== ===== Example =====
 +
 +The example shows how to integrate Clickatell's API using the Custom Dev Kit.
  
 <file php customdevkit.php> <file php customdevkit.php>
-<? +<?php 
-#  MyRSK's Phone Verification System for WHMCS (Custom Dev Kit Example)+#  Layer's Phone Verification System for WHMCS (Custom Dev Kit Example)
 # #
 #  This file contains an example to help you integrate any SMS provider API's gateway.  #  This file contains an example to help you integrate any SMS provider API's gateway. 
-#  The example below shows how to integrate Clickatell's API into MyRSK's PVS Module.+#  The example below shows how to integrate Clickatell's API into Layer's PVS Module.
 #  Please be advised that we do not provide support for custom integrations.  #  Please be advised that we do not provide support for custom integrations. 
 # #
Line 30: Line 39:
  
 #provide api credentials #provide api credentials
- 
 $apiid="123456"; $apiid="123456";
 $apiuser="username"; $apiuser="username";
 $apipassword="password123"; $apipassword="password123";
  
-#provide the content of the SMS message - remember to include the $code varialbe in your message, as that is the code to be sent to the customer+#provide the content of the SMS message - remember to include the $code variable in your message, as that is the code to be sent to the customer
 $body="Hello! The verification code is: ".$code.". Thank you for verifying your account!"; $body="Hello! The verification code is: ".$code.". Thank you for verifying your account!";
  
pvs/integrate_customdevkit.1457017364.txt.gz · Last modified: 2016/03/26 19:06 (external edit)

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki