Download the complete example code here.
Download our local indexer installer here.
Download the file used to start the local indexer process here.

Example of getting access tokens and using them to make a basic API call

using (var client = new HttpClient())
{
    client.BaseAddress = new Uri("https://www.vizseek.com/api/");
    client.DefaultRequestHeaders.Accept.Clear();
    client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));

    //get an access token
    var formContent = new FormUrlEncodedContent(new[]
    {
        //note: username and password are only needed for getting a user access token, not an app access token
        //("grant_type", "password") is used for getting a user access token. Use ("grant_type", "client_credentials") for getting an app access token
        new KeyValuePair<string, string>("grant_type", "password"),
        new KeyValuePair<string, string>("username", "[user name]"),
        new KeyValuePair<string, string>("password", "[password]"), //use SHA1 hash of the actual password
        new KeyValuePair<string, string>("client_id", "[your client id]")//contact us to get a client id
    });

    HttpResponseMessage response = client.PostAsync("token", formContent).Result;
                    
    if (response.IsSuccessStatusCode)//request to get token was successful
    {
        //get access token and refresh token from response
        var responseJson = response.Content.ReadAsStringAsync().Result;
        var jObject = JObject.Parse(responseJson);
        string access_token = jObject.GetValue("access_token").ToString();
        string refreshToken = jObject.GetValue("refresh_token").ToString();
        //note: "expires_in" is in seconds (typically the access token expiration is 30 minutes from now, and the refresh token expiration is in 14 days.
        DateTime userTokenExpiration = DateTime.UtcNow.AddSeconds((double)Int32.Parse(jObject.GetValue("expires_in").ToString()));

        //try an API call with the new token
        client.DefaultRequestHeaders.Add("Authorization", "Bearer " + access_token);
        response = client.GetAsync("Version").Result;
        if (response.IsSuccessStatusCode) //API call was successful
        {        
            string version = response.Content.ReadAsAsync<string>().Result;
        }
    }
}

Example of getting your company ID (or "CompanyVizSpaceID")

//note: this API requires an app access token to be included in the header
//for the password, use SHA1 hash of the actual password
HttpResponseMessage response = client.GetAsync("User?emailID=" + userEmail + "&password=" + userPassword).Result;

UserProfile user = response.Content.ReadAsAsync<UserProfile>().Result;
string myCompanyId = user.CompanyVizSpaceID;

Example of adding a file

//note: this API requires a user access token to be included in the header

byte[] exampleByteArray = new byte[100]; //byte array of the file
//attributes are URL encoded. For this example, attributes would be "color%3Dred%26size%3Dlarge"
string attributes = HttpUtility.UrlEncode("color=red&size=large");

//add to company file database
HttpResponseMessage response = client.PutAsJsonAsync("File?file=exampleFile.png&isSearchInput=false&attributes=" + attributes, JsonConvert.SerializeObject(exampleByteArray)).Result;

//or add just for search. Note: isSearchInput's default value is true;
HttpResponseMessage response = client.PutAsJsonAsync("File?file=.png", JsonConvert.SerializeObject(exampleByteArray)).Result;

string fileUID = response.Content.ReadAsAsync<string>().Result; //get the id of the added file

Example of searching with a file

//note: the Search APIs require a user access token to be included in the header

//with Search GET - using the file we just added using File PUT
//filterStr is URL encoded
string filterStr = HttpUtility.UrlEncode("uid=[your company ID]&fileUID=" + fileUID + "&fileType=image");
HttpResponseMessage response = client.GetAsync("Search?searchTypeStr=file&filterStr=" + filterStr).Result;

//or with Search PUT - using a new file
string[] byteArrays = new string[1];//multiple files could be used
byteArrays[0] = new byte[100]; //byte array of the file
string filterStr = HttpUtility.UrlEncode("uid=[your company id]&fileType=image");
HttpResponseMessage response = client.PutAsJsonAsync("Search?searchTypeStr=file&fileExtension=.png&filterStr=" + filterStr, JsonConvert.SerializeObject(byteArrays)).Result;

//using the search results. See the API Reference page for details about the SearchResultSummary object.
SearchResultSummary search = response.Content.ReadAsAsync<SearchResultSummary>().Result;

Example of using the refresh token

When an access token expires, use the refresh token to get a new access token:

//check if the current access token has expired (this check should be done before any API call is made)
if (userTokenExpiration <= DateTime.UtcNow)
{
    formContent = new FormUrlEncodedContent(new[]
    {
        new KeyValuePair<string, string>("grant_type", "refresh_token"),
        new KeyValuePair<string, string>("refresh_token", refreshToken),
        new KeyValuePair<string, string>("client_id", "[your client id]")
    });

    HttpResponseMessage response = client.PostAsync("token", formContent).Result;
    if (response.IsSuccessStatusCode)
    {
        //get the tokens from the response (as demonstrated above) and set the new access token and refresh token
        access_token = jObject.GetValue("access_token").ToString();
        refreshToken = jObject.GetValue("refresh_token").ToString();
        userTokenExpiration = DateTime.UtcNow.AddSeconds((double)Int32.Parse(jObject.GetValue("expires_in").ToString()));
    }
}

Example of getting access tokens and using them to make a basic API call

//note: username and password are only needed for getting a user access token, not an app access token
//"grant_type=password" is used for getting a user access token. Use "grant_type=client_credentials" for getting an app access token
String postString = String.format("grant_type=password&username=%s&password=%s&client_id=%s", [user name], [password], [your client id]);//use SHA1 hash of the actual password
String RequestURL = "https://www.vizseek.com/api/token";
StringBuilder sb = new StringBuilder();
try {
    URL url = new URL(RequestURL);
    HttpURLConnection conn = (HttpURLConnection) url.openConnection();
    conn.setConnectTimeout(timeout);
    conn.setDoOutput(true);
    conn.setRequestMethod("POST");
    conn.setRequestProperty("Accept", "text/json");
    conn.setRequestProperty("Content-Type", "application/json; charset=utf-8");

    byte[] outputInBytes = postString.getBytes("UTF-8");
    OutputStream os = conn.getOutputStream();
    os.write(outputInBytes);
    os.close();
    BufferedReader br;
    if (200 <= conn.getResponseCode() && conn.getResponseCode() <= 299) {
        br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
    } else {
        br = new BufferedReader(new InputStreamReader((conn.getErrorStream())));
    }
    String output;
    while ((output = br.readLine()) != null)
        sb.append(output);
} catch (MalformedURLException e) {
    e.printStackTrace();
    Log.i(TAG, "MalformedURLException: " + e);
} catch (ProtocolException e) {
    e.printStackTrace();
    Log.i(TAG, "ProtocolException: " + e);
} catch (IOException e) {
    e.printStackTrace();
    Log.i(TAG, "IOException: " + e);
}

String response = sb.toString();
//get access token and refresh token from response
try {
    JSONObject reader = new JSONObject(response);
    String access_token = reader.getString("access_token");
    String refreshToken = reader.getString("refresh_token");
    Log.i(TAG,access_token);
}
catch (JSONException e){
    e.printStackTrace();
}

Example of adding a file

//note: this API requires a user access token to be included in the header

ByteArrayOutputStream stream = new ByteArrayOutputStream();
bitmap.compress(Bitmap.CompressFormat.JPEG, 100, stream);
byte[] byteArrayImage = stream.toByteArray();

Bitmap bitmap = BitmapFactory.decodeResource(getResources(), R.drawable.test);
ByteArrayOutputStream stream = new ByteArrayOutputStream();
bitmap.compress(Bitmap.CompressFormat.JPEG, 100, stream);
byte[] byteArrayImage = stream.toByteArray();
//base64 encode the image
String encodedImage = Base64.encodeToString(byteArrayImage, Base64.DEFAULT);

String bodyStr = "\"\\\"" + encodedImage + "\\\"\"";

//add to company file database
String RequestURL = "File?file=exampleFile.png&isSearchInput=false&attributes=" + attributes;

//or add just for search. Note: isSearchInput's default value is true;
String RequestURL = "https://www.vizseek.com/api/File?file=.jpg";

StringBuilder sb = new StringBuilder();
try {
    URL url = new URL(RequestURL);
    HttpURLConnection conn = (HttpURLConnection) url.openConnection();
    conn.setConnectTimeout(timeout);
    conn.setRequestMethod("PUT");
    conn.setRequestProperty("Accept", "text/json");
    conn.setRequestProperty("Content-Type", "application/json; charset=utf-8");
    conn.addRequestProperty("Authorization", "Bearer " + token);
    byte[] outputInBytes = bodyStr.getBytes("UTF-8");
    OutputStream os = conn.getOutputStream();
    os.write(outputInBytes);
    os.close();
    BufferedReader br;
    if (200 <= conn.getResponseCode() && conn.getResponseCode() <= 299) {
        br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
    } else {
        br = new BufferedReader(new InputStreamReader((conn.getErrorStream())));
    }
    String output;
    while ((output = br.readLine()) != null)
        sb.append(output);
} catch (MalformedURLException e) {
    e.printStackTrace();
    Log.i(TAG, "MalformedURLException: " + e);
} catch (ProtocolException e) {
    e.printStackTrace();
    Log.i(TAG, "ProtocolException: " + e);
} catch (IOException e) {
    e.printStackTrace();
    Log.i(TAG, "IOException: " + e);
}
//returns the id of the added file
String response = sb.toString();
Log.i(TAG,response);

Example of searching with a file

//note: the Search APIs require a user access token to be included in the header

//with Search GET - using the file we just added using File PUT
String filterStr = "uid="+ [your company id] + "&fileUID=" + fileUID + "&fileType=image";

try {
    //filterStr is URL encoded
    encodedfilterStr = URLEncoder.encode(filterStr, "utf-8");
} catch (UnsupportedEncodingException e) {
    e.printStackTrace();
}

String URI = URI = "searchTypeStr=" + [your company type (file or prod)] + "&filterstr=" + encodedfilterStr;
String RequestURL = "https://www.vizseek.com/api/Search";

try {
    URL url = new URL(RequestURL + "?" + URI);
    HttpURLConnection conn = (HttpURLConnection) url.openConnection();
    conn.setConnectTimeout(timeout);
    conn.setRequestMethod("PUT");
    conn.setRequestProperty("Accept", "text/json");
    conn.setRequestProperty("Content-Type", "application/json; charset=utf-8");
    conn.addRequestProperty("Authorization", "Bearer " + token);
    BufferedReader br;
    if (200 <= conn.getResponseCode() && conn.getResponseCode() <= 299) {
        br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
    } else {
        br = new BufferedReader(new InputStreamReader((conn.getErrorStream())));
    }
    String output;
    while ((output = br.readLine()) != null)
        sb.append(output);
} catch (MalformedURLException e) {
    e.printStackTrace();
    Log.i(TAG, "MalformedURLException: " + e);
} catch (ProtocolException e) {
    e.printStackTrace();
    Log.i(TAG, "ProtocolException: " + e);
} catch (IOException e) {
    e.printStackTrace();
    Log.i(TAG, "IOException: " + e);
}

String response = sb.toString();
Log.i(TAG,response);


//or with Search PUT - using a new file
ByteArrayOutputStream stream = new ByteArrayOutputStream();
bitmap.compress(Bitmap.CompressFormat.JPEG, 100, stream);
byte[] byteArrayImage = stream.toByteArray();

//base64 encode the image
String encodedImage = Base64.encodeToString(byteArrayImage, Base64.DEFAULT);

ArrayList<String> inputImageArrayList= new ArrayList<String>;
inputImageArrayList.add(encodedImage)

String bodyStrl;
//multiple files could be used
if (inputImageArrayList.size() > 1) {
    for (int i = 1; i < inputImageArrayList.size(); i++) {
        str += "\\\",\\\"" + inputImageArrayList.get(i);
    }
    bodyStr = "\"[\\\"" + str + "\\\"]\"";
} else {
    Log.i("VizSeek", "single image!");
    bodyStr = "\"[\\\"" + inputImageArrayList.get(0) + "\\\"]\"";
}

String filterStr = "uid="+ [your company id] + "&fileExtension=.jpg&isGZipCompressed=false&fileType=image";

String encodedfilterStr = "";
try {
    encodedfilterStr = URLEncoder.encode(filterStr, "utf-8");
} catch (UnsupportedEncodingException e) {
    e.printStackTrace();
}

String URI = URI = "searchTypeStr=" + [your company type (file or prod)] + "&filterstr=" + encodedfilterStr + "&fileExtension=.jpg&isGZipCompressed=false";
String RequestURL = "https://www.vizseek.com/api/Search";

StringBuilder sb = new StringBuilder();
try {
    URL url = new URL(RequestURL + "?" + URI);
    HttpURLConnection conn = (HttpURLConnection) url.openConnection();
    conn.setConnectTimeout(timeout);
    conn.setRequestMethod("PUT");
    conn.setRequestProperty("Accept", "text/json");
    conn.setRequestProperty("Content-Type", "application/json; charset=utf-8");
    conn.addRequestProperty("Authorization", "Bearer " + token);
    byte[] outputInBytes = bodyStr.getBytes("UTF-8");
    OutputStream os = conn.getOutputStream();
    os.write(outputInBytes);
    os.close();
    BufferedReader br;
    if (200 <= conn.getResponseCode() && conn.getResponseCode() <= 299) {
        br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
    } else {
        br = new BufferedReader(new InputStreamReader((conn.getErrorStream())));
    }
    String output;
    while ((output = br.readLine()) != null)
        sb.append(output);
} catch (MalformedURLException e) {
    e.printStackTrace();
    Log.i(TAG, "MalformedURLException: " + e);
} catch (ProtocolException e) {
    e.printStackTrace();
    Log.i(TAG, "ProtocolException: " + e);
} catch (IOException e) {
    e.printStackTrace();
    Log.i(TAG, "IOException: " + e);
}

String response = sb.toString();
Log.i(TAG,response);

Example of using the refresh token

When an access token expires, use the refresh token to get a new access token:

if(userTokenExpiration  <= System.currentTimeMillis() )
{
    String postString = String.format("grant_type=refresh_token&refresh_token=%s&client_id=%s", refreshToken, [your client id]);
    String RequestURL = "https://www.vizseek.com/api/token";

    //send request to get new token
    //access_token = [new access token]
}