Start

Current Version

This describes the resources that make up the official Cloudopt REST API v1. If you have any problems or requests please contact support.

By default, all requests tohttps://www.cloudopt.net/api/v1 the v1 version of the REST API.

Schema

All API access is over HTTPS, and accessed from the https://www.cloudopt.net/api/v1. All data is sent and received as JSON.

curl -i https://www.cloudopt.net/api/v1/grade/website/www.google.com
HTTP/1.1 200 OK
Server: marco/1.5
Date: Thu, 20 Jul 2017 06:32:47 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 126
Connection: keep-alive
X-Source: C/200
Access-Control-Allow-Credentials: true
X-Download-Options: noopen
Cache-Control: max-age=86400
X-Xss-Protection: 1; mode=block
Strict-Transport-Security: max-age=15552000; includeSubdomains; preload
X-Content-Type-Options: nosniff
X-Frame-Options: DENY
Accept-Ranges: bytes
Expires: Fri, 21 Jul 2017 06:32:21 GMT
Age: 44
X-Request-Id: 1eb195824a4eeb8ec055a8b77466161f; 9937d6bd6de4294b65a6530c74f9cc3c
Via: S.mix-gd-can-003, T.2429.M.1, V.mix-gd-can-009, T.11511.R.1, M.ctn-gd-hen-008

Blank fields are included as""instead of being omitted.

All timestamps return in Unix timestamp :

1499948049991

Client Errors

There are three possible types of client errors on API calls that receive request bodies:

  1. Sending invalid JSON will result in a400 Bad Requestresponse.

    HTTP/1.1 400 Bad Request
    Content-Length: 49
    
    {
        "errorMessage": "Number is error.",
        "error": "100"
    }
    

All error objects have resource and field properties so that your client can tell what the problem is. There's also an error code to let you know what is wrong with the field.

HTTP Verbs

Where possible, API v3 strives to use appropriate HTTP verbs for each action.

Verb Description
HEAD Can be issued against any resource to get just the HTTP header info.
GET Used for retrieving resources.
POST Used for creating resources.
PUT Used for replacing resources or collections. ForPUTrequests with nobodyattribute, be sure to set theContent-Lengthheader to zero.
DELETE Used for deleting resources.

Get website reputation evaluation

GET /grade/website/:url

Parameters

Name Type Description
url string Required. such as www.google.com.

Response

Status: 200 OK
{
    "result": {
        "category": "",
        "date": 1499948049991,
        "holder": "",
        "host": "www.google.com",
        "icp": "",
        "name": "",
        "score": 94,
        "type": "100"
    }
}
Name Type Description
category string The Chinese name of the category to which the web site belongs
score int < 40 is not safe, between 40 and 60 is unknown, > 60 is safe.
type string

The type field

Name Description
100 Unknown sites
101 Personal websites
102 Enterprise website
103 Bank website
104 Shopping websites
105 Game website
201 Phishing websites
202 Dangerous websites

Get number reputation evaluation

GET /api/v1/grade/number/:country/:number

Parameters

Name Type Description
country string Required. City code, such as cn.
number string Required. The number you want to inquire about.

Response

Status: 200 OK
{
    "result": {
        "countryCode": "cn",
        "date": 1500534140030,
        "number": "189****9857",
        "region": "Shenzhen, Guangdong",
        "safe": 0,
        "tag": "intermediary"
    }
}
Name Type Description
safe string 0 is unknown, -1 is dangerous and 1 is safe.

The tag field

Name
advert
express
harassment
defraud
taxi
intermediary

results for ""

    No results matching ""