API文档-图片主题颜色抽取API服务

服务简介 :

本服务可以识别抽取上传图片的主要颜色，从而用户可获取用文字描述的输入图片的主题颜色名称。这有助于对图片的管理及有关颜色的查询。本服务支持自动去除比较简单的背景干扰以便提取图片主要目标物的主要颜色。

应用场景 :

图像库交易平台, 图片素材网站, 图片社区网站, 图片分享APP, 照片图片管理网站及APP。

图片主题颜色抽取API: 用上传图片方式
图片主题颜色抽取API: 用图片URL方式

接口地址 :http://apisim20.wozhitu.com:8084/vsearchtech/imgPnpRest/extractcolor

图片格式要求: JPG格式,图像长及宽约300 – 1200 像素图片

请求方法 :POST

请求参数(body) :

参数名	类型	必填	参数位置	描述	默认值
apikey	string	是	body	API密钥	无
fmt	string	否	body	返回结果格式: json或xml	json
numofcolor	int	否	body	抽取多少个细分颜色；0表示系统自动探测颜色数目	0
bgrdrm	int	否	body	是否去除背景干扰以便提取图片主要目标物的主要颜色 1 - 去除背景 0 – 不去除背景	0 不做自动去除背景

参数名	类型	必填	参数位置	描述	默认值
photo	file	是	body	图片文件	无

														
curl 'http://api1.wozhitu.com:8084/vsearchtech/imgPnpRest/extractcolor' -v -F photo=@dog1.jpg  -F  apikey=您自己的apikey 
														
以上Curl请求上传图片dog1.jpg, 使用您自己的apikey,其他参数用默认值

import java.io.BufferedReader;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.nio.charset.Charset;

import org.apache.http.HttpEntity;
import org.apache.http.protocol.HTTP;
import org.apache.http.client.ClientProtocolException;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.mime.MultipartEntityBuilder;
import org.apache.http.entity.mime.content.FileBody;
import org.apache.http.entity.mime.content.StringBody;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class ApiIcePostImgTest {
	    public static final String APPKEY ="******************************";//APIKEY
	    
	    public static String postImg(File file,String numofcolor) throws IOException{
	    		CloseableHttpClient httpClient = HttpClients.createDefault();
	            CloseableHttpResponse response = null;
	            ContentType contentType = ContentType.create(HTTP.PLAIN_TEXT_TYPE, HTTP.UTF_8);
	            String result =null;
	            try {
	                HttpPost httppost = new HttpPost("http://api1.wozhitu.com:8084/vsearchtech/imgPnpRest/extractcolor");
	                FileBody bin = new FileBody(file);
	                StringBody keyBody = new StringBody(APPKEY , contentType);
	                StringBody numofcolorBody = new StringBody(numofcolor , contentType);
	                MultipartEntityBuilder builder = MultipartEntityBuilder.create();
	                builder.addPart("apikey", keyBody).addPart("photo", bin)
	                .addPart("numofcolor", numofcolorBody);
	                HttpEntity reqEntity =  builder.build();
	                httppost.setEntity(reqEntity);
	                response = httpClient.execute(httppost);
	                HttpEntity resEntity = response.getEntity();
	                if (resEntity != null) {
	                   // result = ConvertStreamToString(resEntity.getContent(), "UTF-8");
	                    String charset = "UTF-8";   
	      			  String content=EntityUtils.toString(response.getEntity(), charset);   
	                    System.out.println(content);
	                }
	                EntityUtils.consume(resEntity);
	            }catch(Exception e){
	                e.printStackTrace();
	            }finally {
	                response.close();
	                httpClient.close();
	            }
	            return result;
	    }
	    
	
	public static void main(String[] args) throws ClientProtocolException, IOException {
		try {
			postImg(new File("dog1.jpg"),"10");
			/*以上请求上传图片dog1.jpg, 使用您自己的apikey, 要求返回10个主颜色，其它参数默认值*/
		} catch (Exception e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}
	}
}

# test_client.py
import requests


data = {
		'apikey': '********************************',
        'numofcolor':'10'
       }
files = [
        ('photo', ('dog1.jpg', open('dog1.jpg', 'rb'), 'image/jpg')),
]       
response = requests.post('http://api1.wozhitu.com:8084/vsearchtech/imgPnpRest/extractcolor',data=data, files=files)
print(response.text)


#以上请求上传图片dog1.jpg, 使用您自己的apikey, 要求返回10个主颜色，其它参数默认值

require 'vendor/autoload.php';
use GuzzleHttp\Client;

$apikey = '*************';
$numofcolor = '10';
$filebody = fopen('dog1.jpg', 'r');
$client = new GuzzleHttp\Client(['base_uri' => 'http://api1.wozhitu.com:8084/vsearchtech/']);
$response = $client->request('POST',  'imgPnpRest/extractcolor', [
    'multipart' => [
			[
	             'name'=> 'numofcolor ',
	            'contents' => $numofcolor 
		    ]
		]
]);

$rbody = $response->getBody();
echo $rbody;

#以上请求上传图片dog1.jpg, 使用您自己的apikey, 要求返回10个主颜色，其它参数默认值

详细使用教程

using System;  
using System.Collections.Generic;  
using System.Linq;  
using System.Text;  
using System.Net.Security;  
using System.Security.Cryptography.X509Certificates;
using System.Collections;
using System.Collections.Specialized;
using System.Net;  
using System.IO;  
using System.IO.Compression;  
using System.Text.RegularExpressions;
namespace ConsoleApplication2
{
   class Program
    {
        public static string HttpUploadFile(string url, string file, string paramName, string contentType, NameValueCollection nvc)
        {
            string result = string.Empty;
            string boundary = "---------------------------" + DateTime.Now.Ticks.ToString("x");
            byte[] boundarybytes = System.Text.Encoding.ASCII.GetBytes("\r\n--" + boundary + "\r\n");

            HttpWebRequest wr = (HttpWebRequest)WebRequest.Create(url);
            wr.ContentType = "multipart/form-data; boundary=" + boundary;
            wr.Method = "POST";
            wr.KeepAlive = true;
            wr.Credentials = System.Net.CredentialCache.DefaultCredentials;

            Stream rs = wr.GetRequestStream();

            string formdataTemplate = "Content-Disposition: form-data; name=\"{0}\"\r\n\r\n{1}";
            foreach (string key in nvc.Keys)
            {
                rs.Write(boundarybytes, 0, boundarybytes.Length);
                string formitem = string.Format(formdataTemplate, key, nvc[key]);
                byte[] formitembytes = System.Text.Encoding.UTF8.GetBytes(formitem);
                rs.Write(formitembytes, 0, formitembytes.Length);
            }
            rs.Write(boundarybytes, 0, boundarybytes.Length);

            string headerTemplate = "Content-Disposition: form-data; name=\"{0}\"; filename=\"{1}\"\r\nContent-Type: {2}\r\n\r\n";
            string header = string.Format(headerTemplate, paramName, file, contentType);
            byte[] headerbytes = System.Text.Encoding.UTF8.GetBytes(header);
            rs.Write(headerbytes, 0, headerbytes.Length);

            FileStream fileStream = new FileStream(file, FileMode.Open, FileAccess.Read);
            byte[] buffer = new byte[4096];
            int bytesRead = 0;
            while ((bytesRead = fileStream.Read(buffer, 0, buffer.Length)) != 0)
            {
                rs.Write(buffer, 0, bytesRead);
            }
            fileStream.Close();

            byte[] trailer = System.Text.Encoding.ASCII.GetBytes("\r\n--" + boundary + "--\r\n");
            rs.Write(trailer, 0, trailer.Length);
            rs.Close();

            WebResponse wresp = null;
            try
            {
                wresp = wr.GetResponse();
                Stream stream2 = wresp.GetResponseStream();
                StreamReader reader2 = new StreamReader(stream2);

                result = reader2.ReadToEnd();
            }
            catch (Exception ex)
            {
                if (wresp != null)
                {
                    wresp.Close();
                    wresp = null;
                }
            }
            finally
            {
                wr = null;
            }

            return result;
        }
        static void Main(string[] args)
            {
        
           	NameValueCollection nvc1 = new NameValueCollection();
            nvc1.Add("apikey", "**************");
            nvc1.Add("numofcolor", "10");
            String s1 =  HttpUploadFile("http://api1.wozhitu.com:8084/vsearchtech/imgPnpRest/extractcolor", @"dog1.jpg", "photo", "image/jpeg", nvc1);
            Console.WriteLine(s1);
            Console.ReadKey();
            //以上请求上传图片dog1.jpg, 使用您自己的apikey, 要求返回10个主颜色，其它参数默认值
         }
        }
}

接口地址 : http://api1.wozhitu.com:8084/vsearchtech/imgPnpRest/extractcolor

图片格式要求: JPG格式,图像长及宽约300 – 1200 像素图片

请求方法 : POST

请求参数(body) :

参数名	类型	必填	参数位置	描述	默认值
apikey	string	是	body	API密钥	无
fmt	string	否	body	返回结果格式: json或xml	json
imgurl	string	是	body	图片地址URL	无
numofcolor	int	否	body	抽取多少个细分颜色	5
bgrdrm	int	否	body	是否去除背景干扰以便提取图片主要目标物的主要颜色 1 - 去除背景 0 – 不去除背景	0 不做自动去除背景

													
Curl请求示例1:
curl 'http://api1.wozhitu.com:8084/vsearchtech/imgPnpRest/extractcolor' -v  -F apikey=您自己的apikey -F  imgurl=http://www.xyz.com/img/dog1.jpg  
													
以上Curl请求上传一个假定图片URL地址位于http://www.xyz.com/img/dog1.jpg, 使用您自己的apikey, 其他参数用默认值.

import java.io.IOException;

import org.apache.http.HttpEntity;
import org.apache.http.protocol.HTTP;
import org.apache.http.client.ClientProtocolException;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.mime.MultipartEntityBuilder;
import org.apache.http.entity.mime.content.StringBody;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class ApiKwdImgUrlTest {
    public static final String APPKEY ="********************************";
	public static String postImgURL(String imgurl,String numofcolor,) throws IOException{
			
			CloseableHttpClient httpClient = HttpClients.createDefault();
	        CloseableHttpResponse response = null;
	        ContentType contentType = ContentType.create(HTTP.PLAIN_TEXT_TYPE, HTTP.UTF_8);
	        String result =null;
	        try {
	            HttpPost httppost = new HttpPost("http://api1.wozhitu.com:8084/vsearchtech/imgPnpRest/extractcolor");
	            StringBody imgUrlBody = new StringBody(imgurl , contentType);
	            StringBody keyBody = new StringBody(APPKEY , contentType);
	            StringBody numofcolorBody = new StringBody(numofcolor , contentType);
	            MultipartEntityBuilder builder = MultipartEntityBuilder.create();
	            builder.addPart("apikey", keyBody).addPart("imgurl", imgUrlBody)
	            .addPart("numofcolor", numofcolorBody);
	            HttpEntity reqEntity =  builder.build();
	            httppost.setEntity(reqEntity);
	            response = httpClient.execute(httppost);
	            HttpEntity resEntity = response.getEntity();
	            if (resEntity != null) {
	               // result = ConvertStreamToString(resEntity.getContent(), "UTF-8");
	                String charset = "UTF-8";   
	  			  String content=EntityUtils.toString(response.getEntity(), charset);   
	                System.out.println(content);
	            }
	            EntityUtils.consume(resEntity);
	        }catch(Exception e){
	            e.printStackTrace();
	        }finally {
	            response.close();
	            httpClient.close();
	        }
	        return result;
		}
	
	public static void main(String[] args) throws ClientProtocolException, IOException {
		try {
			postImgURL("http://www.xyz.com/img/dog1.jpg","10");
			/*以上请求上传图片URLhttp://www.xyz.com/img/dog1.jpg, 使用您自己的apikey, 要求返回10个主颜色，其它参数默认值 */
		} catch (Exception e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}
		
	}
}
/*

# test_client.py
import requests


data = {
		'apikey': '********************************',
        "imgurl" : "http://www.xyz.com/img/dog1.jpg",
        'numofcolor':'10'
       }
response = requests.post('http://api1.wozhitu.com:8084/vsearchtech/imgPnpRest/extractcolor', data)
print(response.text)


#以上请求上传图片URLhttp://www.xyz.com/img/dog1.jpg, 使用您自己的apikey, 要求返回10个主颜色，其它参数默认值

 $query = array(
      "imgurl" => "http://www.xyz.com/img/dog1.jpg",//
      "apikey" => "********************************"//APP Key
      "numofcolor" => "10"
  );
  $result = post2("http://api1.wozhitu.com:8084/vsearchtech/imgPnpRest/extractcolor ",$query);
  echo($result);

 function post2($url, $data){//file_get_content
         
        $postdata = http_build_query(
            $data
        );
 
        $opts = array('http' =>
 
                      array(
                          'method'  => 'POST',
                          'header'  => 'Content-type: application/x-www-form-urlencoded',
                          'content' => $postdata,
                      )
 
        );
 
        $context = stream_context_create($opts);
        $result = file_get_contents($url, false, $context);
        return $result;
    }    


#以上请求上传图片URLhttp://www.xyz.com/img/dog1.jpg, 使用您自己的apikey, 要求返回10个主颜色，其它参数默认值

using System;  
using System.Collections.Generic;  
using System.Linq;  
using System.Text;  
using System.Net.Security;  
using System.Security.Cryptography.X509Certificates;
using System.Collections;
using System.Collections.Specialized;
using System.Net;  
using System.IO;  
using System.IO.Compression;  
using System.Text.RegularExpressions;
namespace ConsoleApplication2
{
    public class HttpWebResponseUtility
    {
        private static readonly string DefaultUserAgent = "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.2; SV1; .NET CLR 1.1.4322; .NET CLR 2.0.50727)";
        
         public static HttpWebResponse CreatePostHttpResponse(string url, IDictionary<string, string> parameters, int? timeout,string path, string userAgent, Encoding requestEncoding, CookieCollection cookies)
        {
            if (string.IsNullOrEmpty(url))
            {
                throw new ArgumentNullException("url");
            }
            if (requestEncoding == null)
            {
                throw new ArgumentNullException("requestEncoding");
            }
            HttpWebRequest request = null;
        
            request = WebRequest.Create(url) as HttpWebRequest;
          
            request.Method = "POST";
            request.ContentType = "application/x-www-form-urlencoded";

            if (!string.IsNullOrEmpty(userAgent))
            {
                request.UserAgent = userAgent;
            }
            else
            {
                request.UserAgent = DefaultUserAgent;
            }

            if (timeout.HasValue)
            {
                request.Timeout = timeout.Value;
            }
            if (cookies != null)
            {
                request.CookieContainer = new CookieContainer();
                request.CookieContainer.Add(cookies);
            }

            Stream stream = request.GetRequestStream();
            if (path != null) 
            { 
                FileStream fs = new FileStream(path, FileMode.Open, FileAccess.Read);
                byte[] bArr = new byte[fs.Length];
                fs.Read(bArr, 0, bArr.Length);
                fs.Close();
               stream.Write(bArr, 0, bArr.Length);
            
            }
        
            if (!(parameters == null || parameters.Count == 0))
            {
                StringBuilder buffer = new StringBuilder();
                int i = 0;
                foreach (string key in parameters.Keys)
                {
                    if (i > 0)
                    {
                        buffer.AppendFormat("&{0}={1}", key, parameters[key]);
                    }
                    else
                    {
                        buffer.AppendFormat("{0}={1}", key, parameters[key]);
                    }
                    i++;
                }
                byte[] data = requestEncoding.GetBytes(buffer.ToString());
                stream.Write(data, 0, data.Length);
            
            }
            return request.GetResponse() as HttpWebResponse;
        }
       
        static void Main(string[] args)
        {
            string url = "http://api1.wozhitu.com:8084/vsearchtech/imgPnpRest/extractcolor";
            IDictionary<string, string> parameters = new Dictionary<string, string>();
            parameters.Add("apikey", "**************");
            parameters.Add("numofcolor", "10");
            parameters.Add("imgurl", "http://www.xyz.com/img/dog1.jpg");
            HttpWebResponse response = HttpWebResponseUtility.CreatePostHttpResponse(url, parameters, null, null, null, Encoding.UTF8, null);
            StringBuilder content = new StringBuilder();
            Stream responseStream = response.GetResponseStream();
            StreamReader sReader = new StreamReader(responseStream, Encoding.GetEncoding("utf-8"));
            Char[] sReaderBuffer = new Char[256];
            int count = sReader.Read(sReaderBuffer, 0, 256);
            while (count > 0)
            {
                String tempStr = new String(sReaderBuffer, 0, count);
                content.Append(tempStr);
                count = sReader.Read(sReaderBuffer, 0, 256);
            }
            sReader.Close();
            Console.WriteLine(content.ToString());
            Console.ReadKey(); 
            //以上请求上传图片URLhttp://www.xyz.com/img/dog1.jpg, 使用您自己的apikey, 要求返回10个主颜色，其它参数默认值 
         }
        }
}

JSON返回示例(返回的weight表示此颜色的权重):

[{"class":"vs.vscore.colorextract.ApiColorExtractResultEntry","clrName":"Olive|橄榄绿(ExactName:OliveDrab)","rgbHexString":"#798d2c","rgbString":"rgb(121,141,44)","weight":0.4548114},{"class":"vs.vscore.colorextract.ApiColorExtractResultEntry","clrName":"Silver|银(ExactName:Gainsboro)","rgbHexString":"#e3dcdb","rgbString":"rgb(227,220,219)","weight":0.30173904},{"class":"vs.vscore.colorextract.ApiColorExtractResultEntry","clrName":"Black|黑(ExactName:DarkSlateGray)","rgbHexString":"#303416","rgbString":"rgb(48,52,22)","weight":0.23812395},{"class":"vs.vscore.colorextract.ApiColorExtractResultEntry","clrName":"Silver|银(ExactName:Tan)","rgbHexString":"#c7b695","rgbString":"rgb(199,182,149)","weight":0.003215477},{"class":"vs.vscore.colorextract.ApiColorExtractResultEntry","clrName":"Green|绿(ExactName:DarkOliveGreen)","rgbHexString":"#3c542c","rgbString":"rgb(60,84,44)","weight":0.002110157}]

错误码参照:

限制类错误:

API_CODE_ERROR_exceeded_access_total	用户总调用量超限
API_CODE_ERROR_exceeded_access_frequency	用户调用频度超限
API_CODE_ERROR_exceeded_access_frequency_min	服务每分钟调用量超限
API_CODE_ERROR_exceeded_access_frequency_hr	服务每小时调用量超限
API_CODE_ERROR_exceeded_access_frequency_day	用户日调用量超限
API_CODE_ERROR_exceeded_access_frequency_month	服务每月调用量超限
API_CODE_ERROR_two_API_calls_time_too_close	两次调用时间太近

调用方法错误:

API_CODE_ERROR_invalid_apikey	Apikey错误
IMAGE_INDEX_ITEM_CODE_ERROR_INVALID_imgName	图片名错误
IMAGE_INDEX_ITEM_CODE_ERROR_INVALID_imgUrl	图片URL错误
IMAGE_INDEX_ITEM_CODE_ERROR_INVALID_LANG	语言参数错误(中文zh 或英语en)
IMAGE_INDEX_CODE_ERROR_IMAGE_SIZE_TOO_BIG	图片太大(最好在400 – 800PIX JPG 图片)