Marketplace

API change history

This API provides an interface to the Veracity marketplace at https://store.veracity.com.

  • Some notes about images: The _key attribute on the SanityImage and SanityReferenceOfSanityImageAsset models is not a unique key for the object, but rather a a new auto-generated GUID every time you call the API. For how to render images, see https://www.sanity.io/docs/presenting-images

Search_GetSearchResult

Try it

Request

Request URL

Request parameters

  • (optional)
    string
  • (optional)
    array
  • (optional)
    array
  • (optional)
    array
  • (optional)
    array
  • (optional)
    integer

    Format - int32.

  • (optional)
    integer

    Format - int32.

  • (optional)
    string

Request headers

  • string
    Subscription key which provides access to this API. Found in your Profile.
  • string
    OAuth 2.0 access token obtained from B2C PROD OAuth - v2 endpoint. Supported grant types: Authorization code.

Request body

Responses

400 Bad Request

Representations

{
  "type": "object",
  "required": [
    "extensions"
  ],
  "properties": {
    "type": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "format": "int32"
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    },
    "extensions": {
      "type": "object",
      "additionalProperties": {}
    }
  }
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "extensions": {}
}
{
  "type": "object",
  "required": [
    "extensions"
  ],
  "properties": {
    "type": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "format": "int32"
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    },
    "extensions": {
      "type": "object",
      "additionalProperties": {}
    }
  }
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "extensions": {}
}
{
  "type": "object",
  "required": [
    "extensions"
  ],
  "properties": {
    "type": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "format": "int32"
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    },
    "extensions": {
      "type": "object",
      "additionalProperties": {}
    }
  }
}

200 OK

Representations

{
  "type": "object",
  "x-abstract": true,
  "required": [
    "continuationToken"
  ],
  "properties": {
    "result": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "isActive",
          "isListed"
        ],
        "properties": {
          "productId": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "cName": {
            "type": "string"
          },
          "summary": {
            "type": "string"
          },
          "additionalInfoString": {
            "type": "string"
          },
          "provider": {
            "type": "string"
          },
          "providerPresentationName": {
            "type": "string"
          },
          "providerDescription": {
            "type": "string"
          },
          "slug": {
            "type": "string"
          },
          "category": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "industry": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "productType": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "isPopular": {
            "type": "boolean"
          },
          "sorting": {
            "type": "number",
            "format": "double"
          },
          "isActive": {
            "type": "boolean"
          },
          "isListed": {
            "type": "boolean"
          }
        }
      }
    },
    "continuationToken": {
      "type": "object",
      "required": [
        "endOfResult"
      ],
      "properties": {
        "key": {
          "type": "string"
        },
        "endOfResult": {
          "type": "boolean"
        }
      }
    }
  }
}
{
  "result": [
    {
      "productId": "string",
      "name": "string",
      "cName": "string",
      "summary": "string",
      "additionalInfoString": "string",
      "provider": "string",
      "providerPresentationName": "string",
      "providerDescription": "string",
      "slug": "string",
      "category": [
        "string"
      ],
      "industry": [
        "string"
      ],
      "productType": [
        "string"
      ],
      "tags": [
        "string"
      ],
      "isPopular": true,
      "sorting": 0.0,
      "isActive": true,
      "isListed": true
    }
  ],
  "continuationToken": {
    "key": "string",
    "endOfResult": true
  }
}
{
  "type": "object",
  "x-abstract": true,
  "required": [
    "continuationToken"
  ],
  "properties": {
    "result": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "isActive",
          "isListed"
        ],
        "properties": {
          "productId": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "cName": {
            "type": "string"
          },
          "summary": {
            "type": "string"
          },
          "additionalInfoString": {
            "type": "string"
          },
          "provider": {
            "type": "string"
          },
          "providerPresentationName": {
            "type": "string"
          },
          "providerDescription": {
            "type": "string"
          },
          "slug": {
            "type": "string"
          },
          "category": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "industry": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "productType": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "isPopular": {
            "type": "boolean"
          },
          "sorting": {
            "type": "number",
            "format": "double"
          },
          "isActive": {
            "type": "boolean"
          },
          "isListed": {
            "type": "boolean"
          }
        }
      }
    },
    "continuationToken": {
      "type": "object",
      "required": [
        "endOfResult"
      ],
      "properties": {
        "key": {
          "type": "string"
        },
        "endOfResult": {
          "type": "boolean"
        }
      }
    }
  }
}
{
  "result": [
    {
      "productId": "string",
      "name": "string",
      "cName": "string",
      "summary": "string",
      "additionalInfoString": "string",
      "provider": "string",
      "providerPresentationName": "string",
      "providerDescription": "string",
      "slug": "string",
      "category": [
        "string"
      ],
      "industry": [
        "string"
      ],
      "productType": [
        "string"
      ],
      "tags": [
        "string"
      ],
      "isPopular": true,
      "sorting": 0.0,
      "isActive": true,
      "isListed": true
    }
  ],
  "continuationToken": {
    "key": "string",
    "endOfResult": true
  }
}
{
  "type": "object",
  "x-abstract": true,
  "required": [
    "continuationToken"
  ],
  "properties": {
    "result": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "isActive",
          "isListed"
        ],
        "properties": {
          "productId": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "cName": {
            "type": "string"
          },
          "summary": {
            "type": "string"
          },
          "additionalInfoString": {
            "type": "string"
          },
          "provider": {
            "type": "string"
          },
          "providerPresentationName": {
            "type": "string"
          },
          "providerDescription": {
            "type": "string"
          },
          "slug": {
            "type": "string"
          },
          "category": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "industry": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "productType": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "isPopular": {
            "type": "boolean"
          },
          "sorting": {
            "type": "number",
            "format": "double"
          },
          "isActive": {
            "type": "boolean"
          },
          "isListed": {
            "type": "boolean"
          }
        }
      }
    },
    "continuationToken": {
      "type": "object",
      "required": [
        "endOfResult"
      ],
      "properties": {
        "key": {
          "type": "string"
        },
        "endOfResult": {
          "type": "boolean"
        }
      }
    }
  }
}

Code samples

@ECHO OFF

curl -v -X GET "https://api.veracity.com/veracity/store/api/v1/Search?searchTerm={string}&industries={array}&categories={array}&productTypes={array}&providers={array}&pageIndex={integer}&pageSize={integer}&page_token={string}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
-H "Authorization: {access token}"

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
            client.DefaultRequestHeaders.Add("Authorization", "{access token}");

            // Request parameters
            queryString["searchTerm"] = "{string}";
            queryString["industries"] = "{array}";
            queryString["categories"] = "{array}";
            queryString["productTypes"] = "{array}";
            queryString["providers"] = "{array}";
            queryString["pageIndex"] = "{integer}";
            queryString["pageSize"] = "{integer}";
            queryString["page_token"] = "{string}";
            var uri = "https://api.veracity.com/veracity/store/api/v1/Search?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.veracity.com/veracity/store/api/v1/Search");

            builder.setParameter("searchTerm", "{string}");
            builder.setParameter("industries", "{array}");
            builder.setParameter("categories", "{array}");
            builder.setParameter("productTypes", "{array}");
            builder.setParameter("providers", "{array}");
            builder.setParameter("pageIndex", "{integer}");
            builder.setParameter("pageSize", "{integer}");
            builder.setParameter("page_token", "{string}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
            request.setHeader("Authorization", "{access token}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "searchTerm": "{string}",
            "industries": "{array}",
            "categories": "{array}",
            "productTypes": "{array}",
            "providers": "{array}",
            "pageIndex": "{integer}",
            "pageSize": "{integer}",
            "page_token": "{string}",
        };
      
        $.ajax({
            url: "https://api.veracity.com/veracity/store/api/v1/Search?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
                xhrObj.setRequestHeader("Authorization","{access token}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.veracity.com/veracity/store/api/v1/Search";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"searchTerm={string}",
                         @"industries={array}",
                         @"categories={array}",
                         @"productTypes={array}",
                         @"providers={array}",
                         @"pageIndex={integer}",
                         @"pageSize={integer}",
                         @"page_token={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    [_request setValue:@"{access token}" forHTTPHeaderField:@"Authorization"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.veracity.com/veracity/store/api/v1/Search');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
    'Authorization' => '{access token}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'searchTerm' => '{string}',
    'industries' => '{array}',
    'categories' => '{array}',
    'productTypes' => '{array}',
    'providers' => '{array}',
    'pageIndex' => '{integer}',
    'pageSize' => '{integer}',
    'page_token' => '{string}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
    'Authorization': '{access token}',
}

params = urllib.urlencode({
    # Request parameters
    'searchTerm': '{string}',
    'industries': '{array}',
    'categories': '{array}',
    'productTypes': '{array}',
    'providers': '{array}',
    'pageIndex': '{integer}',
    'pageSize': '{integer}',
    'page_token': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api.veracity.com')
    conn.request("GET", "/veracity/store/api/v1/Search?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
    'Authorization': '{access token}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'searchTerm': '{string}',
    'industries': '{array}',
    'categories': '{array}',
    'productTypes': '{array}',
    'providers': '{array}',
    'pageIndex': '{integer}',
    'pageSize': '{integer}',
    'page_token': '{string}',
})

try:
    conn = http.client.HTTPSConnection('api.veracity.com')
    conn.request("GET", "/veracity/store/api/v1/Search?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.veracity.com/veracity/store/api/v1/Search')

query = URI.encode_www_form({
    # Request parameters
    'searchTerm' => '{string}',
    'industries' => '{array}',
    'categories' => '{array}',
    'productTypes' => '{array}',
    'providers' => '{array}',
    'pageIndex' => '{integer}',
    'pageSize' => '{integer}',
    'page_token' => '{string}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request headers
request['Authorization'] = '{access token}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body