This documentation has moved

XML API documentation can now be found at developer.openprovider.com. This page will remain available until September 2026, but will no longer be updated.

The XML API itself is not changing. Your existing integration continues to work.

Example Script PHP

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
(Created page with ' <?php echo "Started example script\n\n"; require_once('API.php'); $username = ''; $password = ''; // Create a new API connection $api = new OP_API ('ht…')
 
(One intermediate revision not shown)
Line 5: Line 5:
   require_once('API.php');
   require_once('API.php');
   
   
-
   $username = '';
+
   $username = "";
-
   $password = '';
+
   $password = "";
   
   
   // Create a new API connection
   // Create a new API connection
   $api = new OP_API ('https://api.openprovider.eu');
   $api = new OP_API ('https://api.openprovider.eu');
-
 
-
  $request = new OP_Request;
 
-
  $request->setCommand('createCustomerRequest')
 
-
    ->setAuth(array('username' => $username, 'password' => $password))
 
-
    ->setArgs(array(
 
-
      'companyName' => 'Company Ltd',
 
-
      'name' => array(
 
-
        'initials' => 'J.A.',
 
-
        'firstName' => 'John',
 
-
        'prefix' => '',
 
-
        'lastName' => 'Jones',
 
-
      ),
 
-
      'vat' => null,
 
-
      'gender' => 'M',
 
-
      'phone' => array(
 
-
        'countryCode'  => '+31',
 
-
        'areaCode' => '383',
 
-
        'subscriberNumber' => '1231212'
 
-
      ),
 
-
 
 
-
      'fax' => array(
 
-
        'countryCode' => '+31',
 
-
        'areaCode' => '383',
 
-
        'subscriberNumber' => '1231213'
 
-
      ),
 
-
 
 
-
      'address' => array(
 
-
          'street' => 'Main Avenue',
 
-
          'number' => '2',
 
-
          'suffix' => 'a',
 
-
          'zipcode' => '8817 AB',
 
-
          'city' => 'Rotterdam',
 
-
          'state' => null,
 
-
          'country' => 'NL',
 
-
      ),
 
-
 
 
-
      'email' => 'not@existing.com',
 
-
 
 
-
      'additionalData' => array(
 
-
        'birthDate' => '1958-12-03',
 
-
        'companyRegistrationCity' => 'London',
 
-
        'companyRegistrationNumber' => '7723601',
 
-
        'companyRegistrationSubscriptionDate' => '2003-09-12',
 
-
      )
 
-
    ));
 
-
  $reply = $api->setDebug(1)->process($request);
 
-
  $response = $reply->getValue();
 
-
  $handle = $response['handle'];
 
-
  echo "Code: " . $reply->getFaultCode() . "\n";
 
-
  echo "Error: " . $reply->getFaultString() . "\n";
 
-
  echo "Handle: " . $handle."\n";
 
-
  echo "\n---------------------------------------\n";
 
-
 
-
  $request = new OP_Request;
 
-
  $request->setCommand('deleteCustomerRequest')
 
-
    ->setAuth(array('username' => $username, 'password' => $password))
 
-
    ->setArgs(array(
 
-
      'handle' => $handle,
 
-
    ));
 
-
  $reply = $api->setDebug(1)->process($request);
 
-
  echo "\n---------------------------------------\n";
 
-
 
-
 
-
  $request = new OP_Request;
 
-
  $request->setCommand('retrieveDomainRequest')
 
-
    ->setAuth(array('username' => $username, 'password' => $password))
 
-
    ->setArgs(array(
 
-
      'domain' => array(
 
-
        'name' => 'openprovider',
 
-
        'extension' => 'nl'
 
-
      ),
 
-
      'withAdditionalData' => 0
 
-
    ));
 
-
  $reply = $api->setDebug(1)->process($request);
 
-
  echo "Code: " . $reply->getFaultCode() . "\n";
 
-
  echo "Error: " . $reply->getFaultString() . "\n";
 
-
  echo "Value: " . print_r($reply->getValue(), true) . "\n";
 
-
  echo "\n---------------------------------------\n";
 
   
   
   $request = new OP_Request;
   $request = new OP_Request;
Line 100: Line 22:
     );
     );
   $reply = $api->setDebug(1)->process($request);
   $reply = $api->setDebug(1)->process($request);
-
   print_r($reply->getValue());
+
   echo "Code: " . $reply->getFaultCode() . "\n";
 +
  echo "Error: " . $reply->getFaultString() . "\n";
 +
  echo "Value: " . print_r($reply->getValue(), true) . "\n";
   echo "\n---------------------------------------\n";
   echo "\n---------------------------------------\n";
   
   

Current revision as of 12:48, 16 October 2013

<?php

  echo "Started example script\n\n";

  require_once('API.php');

  $username = "";
  $password = "";

  // Create a new API connection
  $api = new OP_API ('https://api.openprovider.eu');

  $request = new OP_Request;
  $request->setCommand('checkDomainRequest')
    ->setAuth(array('username' => $username, 'password' => $password))
    ->setArgs(array(
      'domains' => array(
          array('name' => 'openprovider', 'extension' => 'nl'),
          array('name' => 'non-existing-domain', 'extension' => 'co.uk')
        )
      )
    );
  $reply = $api->setDebug(1)->process($request);
  echo "Code: " . $reply->getFaultCode() . "\n";
  echo "Error: " . $reply->getFaultString() . "\n";
  echo "Value: " . print_r($reply->getValue(), true) . "\n";
  echo "\n---------------------------------------\n";

  echo "Finished example script\n\n";

?>
Views
Personal tools