Valence API D2L/Brightspace API calls from WordPress Site

2 comments

1. According to the documentation for the create-user route, a 400 status code as a response indicates one of two things: you’ve provided invalid data for your new user record somehow, or the back-end service was (for some reason) unable to create the new user record (very rare, but it does happen). In the second of those cases, you’d get a more detailed message in the error description indicating the failure to create. As you didn’t get this, the most likely reason is one of these:

   • You’re not sending what you think you’re sending; it’s somehow badly formatted.

   • You’re providing an invalid RoleId — it was valid in the environment you tested under, but in the production environment, that RoleId doesn’t exist. This happens sometimes, but in this case, I suspect not. To verify, try fetching back the RoleId by Id first, and view those results.

   • You’re providing a UserNamethat already exists in the system: this property is the ID you use to identify yourself when you log in to the Brightspace system, so it has to be unique. Occasionally clients will find that the “temporary test” UserName they’re using already exists in their back-end service, for whatever reason, and this can cause surprising failures. You can try validating by fetching back a user by that UserName first to validate you don’t already have a record for that user.

2. I have since been able to solve this issue with some help. below is the code that I used, in case there are others who come across this in the future.

   1. excerpt PHP where the form is kept:

                              <input class="required textInput" id="name_first" name="name_first"  size="35" maxlength="255" placeholder= "First Name"  type="text" value="<?php echo $_SESSION["student_profile"]["name_first"]; ?>" required />
                              <label class="required_lables" for="name_first"><em></em></label>
      
                              <!--  Middle Initial  -->
                              <label for="name_middle"><em></em></label>
                              <input class="textInput optional" id="name_middle" name="name_middle" size="35" maxlength="255" placeholder= "Middle Name (optional)" type="text" value="<?php echo $_SESSION["student_profile"]["name_middle"]; ?>" />
      
                              <!--  Last Name  -->
                              <input class="required textInput" id="name_last" name="name_last"  size="35" maxlength="255" placeholder= "Last Name" type="text" value="<?php echo $_SESSION["student_profile"]["name_last"]; ?>" required/>
                              <label class="required_lables" for="name_last"><em></em></label>
      

   2. Form submission page. The Ajax call is made in here:

      $_SESSION[‘student_profile’] = $_POST;

      $first_name=$_SESSION[‘student_profile’][‘name_first’];

      $middle_name =$_SESSION[‘student_profile’][‘middle_name ‘];

      $last_name =$_SESSION[‘student_profile’][‘last_name ‘];

      $email =$_SESSION[‘student_profile’][’email ‘];

      echo '<script>';
      echo 'var data = {"OrgDefinedId": "'. $orgDefinedId .'",  "FirstName": "'. $first_name .'",  "MiddleName": "'. $middle_name .'",  "LastName": "'. $last_name .'",  "ExternalEmail": "'. $email .'",  "UserName": "'. $uName .'",  "RoleId": 103,  "IsActive": true,  "SendCreationEmail": false};';
      echo 'var type = "CREATE";';
      echo 'window.$vars = {dataField : data};';
      echo 'window.$vartype = {typeField : type};';
      echo 'doAPIRequest();';//direction to js file with the ajax call
      echo '</script>';
      
      ?>
      

   3. Ajax that is used in wordpress: The action used is called example_wordpress_action and it is defined in functions.php

      function doAPIRequest() {
       var host = "myHostSite.com";
       var port = "443";
       var scheme = "https";
       var req = "/d2l/api/lp/1.4/users/";
       var method =  "POST";
       var typeAPI = window.$vartype.typeField;
       var ajaxurl = "/wp-admin/admin-ajax.php";  
       var data = window.$vars.dataField;     
       var userName = window.$varsUname.useNameField;
       var anon = "";
       var appId = myAppID;
       var appKey = myAppKey;
              $.ajax({
                  url: ajaxurl,
                  data: {
                      action : 'example_wordpress_action',
                      host: host,
                      port: port,
                      scheme: scheme,
                      anon: anon,
                      apiRequest: req,
                      typeapp: typeAPI,
                      apiMethod: method,
                      appUser: userName,
                      data: data,
                      appId: appId,
                      appKey: appKey
                  },
                  success: function(data) {
                      var output;
                      if(data == '') {
                          output = 'Success!';
                          return;
                      } else {
                          try {
                              output = JSON.stringify(JSON.parse(data), null, 4);
                          } catch(e) {
                              output = "Unexpected non-JSON response from the server: " + data;
                          }
                      }
                  },
                  error: function(jqXHR, textStatus, errorThrown) {               
                  },
              });
      

      }

   4. Funcions.php where the request is made using wp_remote_request:

   function example_wordpress_action_function() {

       $host = $_GET['host'];
       $port = $_GET['port'];
       $scheme = $_GET['scheme'];
       $data = $_GET['data'];
       $apiMethod = $_GET['apiMethod'];
       $appId = $_GET['appId'];
       $appKey = $_GET['appKey'];
       $appRequest = $_GET['apiRequest'];
       $appUserName = $_GET['appUser'];
   
       $data_string = json_encode($data);
   
       $userId = $myUserId;
       $userKey = $myUserKey;
   
       $authContextFactory = new D2LAppContextFactory();
       $authContext = $authContextFactory->createSecurityContext($appId, $appKey);
       $hostSpec = new D2LHostSpec($host, $port, $scheme);
       $opContext = $authContext->createUserContextFromHostSpec($hostSpec, $userId, $userKey);
   
       $uri = $opContext->createAuthenticatedUri($appRequest, $apiMethod);
       $headers = array( 'authorization' => 'basic ', 'accept' => 'application/json', 'content-type' => 'application/json', 'content-length' => strlen( $data_string ) ); 
       $post = array( 'method' => $apiMethod, 'headers' => $headers, 'body' => $data_string );
       $createResponses = wp_remote_request($uri, $post);
       die();
   }
   add_action( 'wp_ajax_example_wordpress_action', 'example_wordpress_action_function' );
   add_action("wp_ajax_nopriv_example_wordpress_action", "example_wordpress_action_function");
   

Comments are closed.