Skip to content

Commit b5ad9aa

Browse files
committed
Convert to Markdown to allow for syntax highlighting
1 parent 28913df commit b5ad9aa

File tree

1 file changed

+22
-20
lines changed

1 file changed

+22
-20
lines changed

README.textile renamed to README.md

+22-20
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,44 @@
1-
h1. A SoftLayer API PHP client.
1+
# A SoftLayer API PHP client.
22

3-
h2. Warning
3+
## Warning
44

5-
```The latest version 1.x is not backwards-compatible.
6-
It is necessary to update scripts to function properly with the new version.```
5+
```
6+
The latest version 1.x is not backwards-compatible.
7+
It is necessary to update scripts to function properly with the new version.
8+
```
79

8-
h2. Overview
10+
## Overview
911

1012
The SoftLayer API PHP client classes provide a simple method for connecting to and making calls from the SoftLayer API and provides support for many of the SoftLayer API's features. Method calls and client management are handled by the PHP SOAP and XML-RPC extensions.
1113

1214
Making API calls using the `\SoftLayer\SoapClient` or `\SoftLayer\XmlRpcClient` classes is done in the following steps:
1315

14-
# Instantiate a new `\SoftLayer\SoapClient` or `\SoftLayer\XmlRpcClient` object using the `\SoftLayer\SoapClient::getClient()` or `\SoftLayer\XmlRpcClient::getClient()` methods. Provide the name of the service that you wish to query, an optional id number of the object that you wish to instantiate, your SoftLayer API username, your SoftLayer API key, and an optional API endpoint base URL. The client classes default to connect over the public Internet. Enter `\SoftLayer\SoapClient::API_PRIVATE_ENDPOINT` or `\SoftLayer\XmlRpcClient::API_PRIVATE_ENDPOINT` to connect to the API over SoftLayer's private network. The system making API calls must be connected to SoftLayer's private network (eg. purchased from SoftLayer or connected via VPN) in order to use the private network API endpoints.
15-
# Define and add optional headers to the client, such as object masks and result limits.
16-
# Call the API method you wish to call as if it were local to your client object. This class throws exceptions if it's unable to execute a query, so it's best to place API method calls in try / catch statements for proper error handling.
16+
1. Instantiate a new `\SoftLayer\SoapClient` or `\SoftLayer\XmlRpcClient` object using the `\SoftLayer\SoapClient::getClient()` or `\SoftLayer\XmlRpcClient::getClient()` methods. Provide the name of the service that you wish to query, an optional id number of the object that you wish to instantiate, your SoftLayer API username, your SoftLayer API key, and an optional API endpoint base URL. The client classes default to connect over the public Internet. Enter `\SoftLayer\SoapClient::API_PRIVATE_ENDPOINT` or `\SoftLayer\XmlRpcClient::API_PRIVATE_ENDPOINT` to connect to the API over SoftLayer's private network. The system making API calls must be connected to SoftLayer's private network (eg. purchased from SoftLayer or connected via VPN) in order to use the private network API endpoints.
17+
2. Define and add optional headers to the client, such as object masks and result limits.
18+
3. Call the API method you wish to call as if it were local to your client object. This class throws exceptions if it's unable to execute a query, so it's best to place API method calls in try / catch statements for proper error handling.
1719

1820
Once your method is executed you may continue using the same client if you need to connect to the same service or define another client object if you wish to work with multiple services at once.
1921

20-
The most up to date version of this library can be found on the SoftLayer github public repositories: "http://github.com/softlayer/":http://github.com/softlayer/ . Please post to the SoftLayer forums <"http://forums.softlayer.com/":http://forums.softlayer.com/> or open a support ticket in the SoftLayer customer portal if you have any questions regarding use of this library.
22+
The most up to date version of this library can be found on the SoftLayer github public repositories: [http://github.com/softlayer/](http://github.com/softlayer/) . Please post to the SoftLayer forums <[http://forums.softlayer.com/](http://forums.softlayer.com/)> or open a support ticket in the SoftLayer customer portal if you have any questions regarding use of this library.
2123

22-
h2. System Requirements
24+
## System Requirements
2325

2426
The `\SoftLayer\SoapClient` class requires at least PHP 5.3.0 and the PHP SOAP enxtension installed. The `\SoftLayer\XmlRpcClient` class requires PHP at least PHP 5 and the PHP XML-RPC extension installed.
2527

2628
A valid API username and key are required to call the SoftLayer API. A connection to the SoftLayer private network is required to connect to SoftLayer's private network API endpopints.
2729

28-
h2. Installation
30+
## Installation
2931

30-
Install the SoftLayer API client using "Composer":https://getcomposer.org/.
31-
<pre><code>
32+
Install the SoftLayer API client using [Composer](https://getcomposer.org/).
33+
```bash
3234
composer require softlayer/softlayer-api-php-client:~1.0@dev
33-
</code></pre>
35+
```
3436

35-
h2. Usage
37+
## Usage
3638

3739
These examples use the `\SoftLayer\SoapClient` class. If you wish to use the XML-RPC API then replace mentions of `SoapClient.class.php` with `XmlrpcClient.class.php` and `\SoftLayer\SoapClient` with `\SoftLayer\XmlRpcClient`.
3840

39-
Here's a simple usage example that retrieves account information by calling the "getObject()":http://sldn.softlayer.com/reference/services/SoftLayer_Account/getObject method in the "SoftLayer_Account":http://sldn.softlayer.com/reference/services/SoftLayer_Account service:
41+
Here's a simple usage example that retrieves account information by calling the [getObject()](http://sldn.softlayer.com/reference/services/SoftLayer_Account/getObject) method in the [SoftLayer_Account](http://sldn.softlayer.com/reference/services/SoftLayer_Account) service:
4042

4143
```php
4244
<?php
@@ -97,10 +99,10 @@ try {
9799
}
98100
```
99101

100-
h2. Author
102+
## Author
101103

102-
This software is written by the SoftLayer Development Team <"[email protected]":mailto:[email protected]>.
104+
This software is written by the SoftLayer Development Team <[[email protected]](mailto:[email protected])>.
103105

104-
h2. Copyright
106+
## Copyright
105107

106-
This software is Copyright (c) 2009 - 2010 "SoftLayer Technologies, Inc":http://www.softlayer.com/. See the bundled LICENSE.textile file for more information.
108+
This software is Copyright &copy; 2009 2010 [SoftLayer Technologies, Inc](http://www.softlayer.com/). See the bundled LICENSE.textile file for more information.

0 commit comments

Comments
 (0)