Skip to content

Commit c0430d6

Browse files
add seo api docs
1 parent 453999e commit c0430d6

File tree

2 files changed

+124
-0
lines changed

2 files changed

+124
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -238,6 +238,9 @@ Class | Method | HTTP request | Description
238238
*Asposehtmlcloud.DocumentApi* | [**GetDocumentImagesByUrl**](docs/DocumentApi.md#GetDocumentImagesByUrl) | **GET** /html/images/all | Return all HTML page images packaged as a ZIP archive by the source page URL.
239239
*Asposehtmlcloud.TemplateMergeApi* | [**GetMergeHtmlTemplate**](docs/TemplateMergeApi.md#GetMergeHtmlTemplate) | **GET** /html/{templateName}/merge | Populate HTML document template with data located as a file in the storage.
240240
*Asposehtmlcloud.TemplateMergeApi* | [**PostMergeHtmlTemplate**](docs/TemplateMergeApi.md#PostMergeHtmlTemplate) | **POST** /html/{templateName}/merge | Populate HTML document template with data from the request body. Result document will be saved to storage.
241+
*Asposehtmlcloud.SeoApi* | [**GetSeoWarning**](docs/SeoApi.md#GetSeoWarning) | **GET** /html/seo | Page analysis and return SEO warnings in json format.
242+
*Asposehtmlcloud.SeoApi* | [**GetHtmlWarning**](docs/SeoApi.md#GetHtmlWarning) | **GET** /html/validator | Checks the markup validity of Web documents in HTML, XHTML, etc.and return in json format.
243+
241244

242245
<a name="storage_api"></a>
243246
### STORAGE API

docs/SeoApi.md

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
<a name="SeoApi"></a>
2+
# Asposehtmlcloud.SeoApi
3+
4+
All URIs are relative to *https://api.aspose.cloud/v3.0*
5+
6+
Method | HTTP request | Description
7+
------------- | ------------- | -------------
8+
[**GetSeoWarning**](SeoApi.md#GetSeoWarning) | **GET** /html/seo | Page analysis and return SEO warnings in json format.
9+
[**GetHtmlWarning**](SeoApi.md#GetHtmlWarning) | **GET** /html/validator | Checks the markup validity of Web documents in HTML, XHTML, etc.and return in json format.
10+
11+
12+
<a name="GetSeoWarning"></a>
13+
# **GetSeoWarning**
14+
> File GetSeoWarning(addr)
15+
16+
Page analysis and return SEO warnings in json format.
17+
18+
### Example
19+
```javascript
20+
var Asposehtmlcloud = require('@asposecloud/aspose-html-cloud');
21+
22+
// Get keys from aspose site.
23+
// There is free quota available.
24+
// For more details, see https://purchase.aspose.cloud/pricing
25+
26+
var conf = {
27+
"basePath":"https://api.aspose.cloud/v3.0",
28+
"authPath":"https://api.aspose.cloud/connect/token",
29+
"apiKey":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
30+
"appSID":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
31+
"defaultUserAgent":"Webkit"
32+
};
33+
34+
var apiInstance = new Asposehtmlcloud.SeoApi(conf);
35+
36+
var addr = "url_example"; // String | URL for analysis.
37+
38+
var callback = function(error, data, response) {
39+
if (error) {
40+
console.error(error);
41+
} else {
42+
console.log('API called successfully. Returned data: ' + data);
43+
}
44+
};
45+
apiInstance.GetSeoWarning(addr, callback);
46+
```
47+
48+
### Parameters
49+
50+
Name | Type | Description | Notes
51+
------------- | ------------- | ------------- | -------------
52+
**addr** | **String**| Source url. |
53+
54+
55+
### Return type
56+
57+
**Blob**
58+
59+
### HTTP request headers
60+
61+
- **Content-Type**: application/json
62+
- **Accept**: application/json
63+
64+
[&#8593;UP&#8593;](SeoApi.md#SeoApi)
65+
66+
67+
<a name="GetHtmlWarning"></a>
68+
# **GetHtmlWarning**
69+
> File GetHtmlWarning(url)
70+
71+
Checks the markup validity of Web documents in HTML, XHTML, etc.and return in json format.
72+
73+
74+
### Example
75+
```javascript
76+
var Asposehtmlcloud = require('@asposecloud/aspose-html-cloud');
77+
78+
// Get keys from aspose site.
79+
// There is free quota available.
80+
// For more details, see https://purchase.aspose.cloud/pricing
81+
82+
var conf = {
83+
"basePath":"https://api.aspose.cloud/v3.0",
84+
"authPath":"https://api.aspose.cloud/connect/token",
85+
"apiKey":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
86+
"appSID":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
87+
"defaultUserAgent":"Webkit"
88+
};
89+
90+
var apiInstance = new Asposehtmlcloud.SeoApi(conf);
91+
92+
var url = "url_example"; // String | URL for analysis.
93+
94+
var callback = function(error, data, response) {
95+
if (error) {
96+
console.error(error);
97+
} else {
98+
console.log('API called successfully. Returned data: ' + data);
99+
}
100+
};
101+
apiInstance.GetHtmlWarning(addr, callback);
102+
```
103+
104+
### Parameters
105+
106+
Name | Type | Description | Notes
107+
------------- | ------------- | ------------- | -------------
108+
**url** | **String**| Source url. |
109+
110+
111+
### Return type
112+
113+
**Blob**
114+
115+
### HTTP request headers
116+
117+
- **Content-Type**: application/json
118+
- **Accept**: application/json
119+
120+
[&#8593;UP&#8593;](SeoApi.md#SeoApi)
121+

0 commit comments

Comments
 (0)