You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+79-64Lines changed: 79 additions & 64 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,22 +4,21 @@
4
4
## Introduction
5
5
6
6
Maxio Advanced Billing (formerly Chargify) provides an HTTP-based API that conforms to the principles of REST.
7
-
One of the many reasons to use Advanced Billing is the immense feature set and surrounding community [client libraries](page:development-tools/client-libraries).
8
-
The Maxio API returns JSON responses as the primary and recommended format, but XML is also provided as a backwards compatible option for Merchants who require it.
7
+
One of the many reasons to use Advanced Billing is the immense feature set and [client libraries](page:development-tools/client-libraries).
8
+
The Maxio API returns JSON responses as the primary and recommended format, but XML is also provided as a backwards compatible option for merchants who require it.
9
9
10
10
### Steps to make your first Maxio Advanced Billing API call
11
11
12
12
1.[Sign-up](https://app.chargify.com/signup/maxio-billing-sandbox) or [log-in](https://app.chargify.com/login.html) to your [test site](https://maxio.zendesk.com/hc/en-us/articles/24250712113165-Testing-Overview) account.
13
-
2.[Setup and configure authentication](https://maxio.zendesk.com/hc/en-us/articles/24294819360525-API-Keys) credentials.
3.[Submit an API request and verify the response](page:development-tools/client-libraries#make-your-first-maxio-advanced-billing-api-request).
15
+
4. Test the Advanced Billing [integrations](https://www.maxio.com/integrations).
17
16
18
-
We strongly suggest exploring the developer portal, our [integrations](https://www.maxio.com/integrations) and the API guide, as well as the entire set of application-based documentation to aid in your discovery of the product.
17
+
Next, you can explore [authentication methods](page:introduction/authentication), [basic concepts](page:introduction/basic-concepts/connected-sites) for interacting with Advanced Billing via the API, and the entire set of [application-based documentation](https://docs.maxio.com/hc/en-us) to aid in your discovery of the product.
19
18
20
-
#### Example
19
+
#### Request Example
21
20
22
-
The following example uses the curl command-line tool to execute API requests.
21
+
The following example uses the curl command-line tool to make an API request.
23
22
24
23
**Request**
25
24
@@ -33,29 +32,35 @@ Install the SDK by adding the following dependency in your project's pom.xml fil
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/client.md)
44
+
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/client.md)
46
45
47
46
The following parameters are configurable for the API Client:
48
47
49
48
| Parameter | Type | Description |
50
49
| --- | --- | --- |
51
-
|`site`|`String`| The subdomain for your Advanced Billing site.<br>*Default*: `"subdomain"`|
52
-
|`environment`|`Environment`| The API environment. <br> **Default: `Environment.US`**|
53
-
|`httpClientConfig`|[`Consumer<HttpClientConfiguration.Builder>`](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/http-client-configuration-builder.md)| Set up Http Client Configuration instance. |
54
-
|`basicAuthCredentials`|[`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/auth/basic-authentication.md)| The Credentials Setter for Basic Authentication |
50
+
| site |`String`| The subdomain for your Advanced Billing site.<br>*Default*: `"subdomain"`|
51
+
| environment |`Environment`| The API environment. <br> **Default: `Environment.US`**|
52
+
| httpClientConfig |[`Consumer<HttpClientConfiguration.Builder>`](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/http-client-configuration-builder.md)| Set up Http Client Configuration instance. |
53
+
| basicAuthCredentials |[`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/auth/basic-authentication.md)| The Credentials Setter for Basic Authentication |
Copy file name to clipboardExpand all lines: doc/client.md
+11-5Lines changed: 11 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,14 +5,20 @@ The following parameters are configurable for the API Client:
5
5
6
6
| Parameter | Type | Description |
7
7
| --- | --- | --- |
8
-
|`site`|`String`| The subdomain for your Advanced Billing site.<br>*Default*: `"subdomain"`|
9
-
|`environment`|`Environment`| The API environment. <br> **Default: `Environment.US`**|
10
-
|`httpClientConfig`|[`Consumer<HttpClientConfiguration.Builder>`](http-client-configuration-builder.md)| Set up Http Client Configuration instance. |
11
-
|`basicAuthCredentials`|[`BasicAuthCredentials`](auth/basic-authentication.md)| The Credentials Setter for Basic Authentication |
8
+
| site |`String`| The subdomain for your Advanced Billing site.<br>*Default*: `"subdomain"`|
9
+
| environment |`Environment`| The API environment. <br> **Default: `Environment.US`**|
10
+
| httpClientConfig |[`Consumer<HttpClientConfiguration.Builder>`](../doc/http-client-configuration-builder.md)| Set up Http Client Configuration instance. |
11
+
| basicAuthCredentials |[`BasicAuthCredentials`](auth/basic-authentication.md)| The Credentials Setter for Basic Authentication |
0 commit comments