Permalink
Browse files

Fix readme (#21)

* [readme] fix

* comments correction
  • Loading branch information...
1 parent 0522698 commit b6c6709a4369dfca7f5f1d1e64ff87515261bfec @VinayBhalerao VinayBhalerao committed with mikz May 10, 2017
Showing with 11 additions and 1 deletion.
  1. +10 −0 README.markdown
  2. +1 −1 lib/ThreeScaleClient.php
View
@@ -192,6 +192,16 @@ $response->getErrorCode() // "provider_key_invalid"
$response->getErrorMessage() // "provider key \"foo\" is invalid"
```
+## Custom backend for the 3scale Service Management API
+
+The default URI used for the 3scale Service Management API is http://su1.3scale.net:80. This value can be changed, which is useful when the plugin is used together with the on-premise version of the Red Hat 3scale API Management Platform.
+
+In order to override the URL, pass the `custom URI` while creating instance an instance of the client
+
+```php
+$client = new ThreeScaleClient(null, "http://custom-backend.example.com:8080");
+```
+
## Plugin integration
If you are interested in integrating the plugin with:
View
@@ -18,7 +18,7 @@
*
* Objects of this class are stateless and can be shared through multiple
* transactions and by multiple clients.
- * DEFAULT_ROOT_ENDPOINT su1.3scale.net communicates with 3scale SAAS platform. When connecting to an on-premise instance of the 3scale platform, replace it with correct scheme, host and port
+ * DEFAULT_ROOT_ENDPOINT su1.3scale.net communicates with 3scale SAAS platform
*/
class ThreeScaleClient {
const DEFAULT_ROOT_ENDPOINT = 'http://su1.3scale.net';

0 comments on commit b6c6709

Please sign in to comment.