API Endpoints
API Endpoints
All endpoints are accessed on https from edge.curalate.com. For example, a request to access the media for the sample data source looks like:
https://edge.curalate.com/v1/media/DKQGLerBTQCDXwNS
Endpoints are RESTful and return JSON responses. Each response includes a traceId that can be used to communicate to the support team if issues are encountered.
API console
A swagger-based API console is provided here.
Pagination
The responses on endpoints that return a results list include pagination bookmarks before and after that can be passed to subsequent requests to fetch the next page of results. These endpoints have a default page size, which can be overridden with the limit parameter.
EXAMPLE RESPONSE
A sample response from a GET /media API Request
{
"data": {
"items": [
{
"id": "3d9f9d4b-529c-4fc3-92b1-53df2ee84492",
"source": {
"type": "instagram",
"postedTimestamp": 1433621858,
"user": {
"username": "melissaivone",
"link": "https://instagram.com/melissaivone",
"image": {
"original": {
"link": "https://edge.curalate.com/v1/img/L5CGL_THwe8B5o325ud-6EUh6pCGpOWyt-f1ePcSaaI="
},
"small": {
"link": "https://edge.curalate.com/v1/img/L5CGL_THwe8B5o325ud-6EUh6pCGpOWyt-f1ePcSaaI=/w/150"
},
"medium": {
"link": "https://edge.curalate.com/v1/img/L5CGL_THwe8B5o325ud-6EUh6pCGpOWyt-f1ePcSaaI=/w/300"
},
"smallSquare": {
"link": "https://edge.curalate.com/v1/img/L5CGL_THwe8B5o325ud-6EUh6pCGpOWyt-f1ePcSaaI=/sc/150x150"
},
"mediumSquare": {
"link": "https://edge.curalate.com/v1/img/L5CGL_THwe8B5o325ud-6EUh6pCGpOWyt-f1ePcSaaI=/sc/300x300"
}
},
"followerCount": 1179,
"followingCount": 1032
},
"link": "https://www.instagram.com/p/3mc7ljGfTR/",
"caption": "Took a midday ice cream break on Thursday to welcome new #Curalate team member, Griffin! #VSCOcam #philly #Philadelphia #icecream #popsicles @rivalbroscoffee @lilpopshop @weckerlys",
"commentCount": 3,
"likeCount": 27
},
"media": {
"type": "photo",
"original": {
"link": "https://edge.curalate.com/v1/img/YwBM0ugTukDSR5ZN98Uq1WhuaVE70wFnVh1XNAO1SCA="
},
"small": {
"link": "https://edge.curalate.com/v1/img/YwBM0ugTukDSR5ZN98Uq1WhuaVE70wFnVh1XNAO1SCA=/w/150"
},
"medium": {
"link": "https://edge.curalate.com/v1/img/YwBM0ugTukDSR5ZN98Uq1WhuaVE70wFnVh1XNAO1SCA=/w/300"
},
"large": {
"link": "https://edge.curalate.com/v1/img/YwBM0ugTukDSR5ZN98Uq1WhuaVE70wFnVh1XNAO1SCA=/w/600"
},
"extraLarge": {
"link": "https://edge.curalate.com/v1/img/YwBM0ugTukDSR5ZN98Uq1WhuaVE70wFnVh1XNAO1SCA=/w/1080"
},
"smallSquare": {
"link": "https://edge.curalate.com/v1/img/YwBM0ugTukDSR5ZN98Uq1WhuaVE70wFnVh1XNAO1SCA=/sc/150x150?spatialTags=0.698000:0.690000,0.572000:0.512000,0.316000:0.468000,0.332000:0.676000,0.166000:0.706000"
},
"mediumSquare": {
"link": "https://edge.curalate.com/v1/img/YwBM0ugTukDSR5ZN98Uq1WhuaVE70wFnVh1XNAO1SCA=/sc/300x300?spatialTags=0.698000:0.690000,0.572000:0.512000,0.316000:0.468000,0.332000:0.676000,0.166000:0.706000"
},
"largeSquare": {
"link": "https://edge.curalate.com/v1/img/YwBM0ugTukDSR5ZN98Uq1WhuaVE70wFnVh1XNAO1SCA=/sc/600x600?spatialTags=0.698000:0.690000,0.572000:0.512000,0.316000:0.468000,0.332000:0.676000,0.166000:0.706000"
},
"extraLargeSquare": {
"link": "https://edge.curalate.com/v1/img/YwBM0ugTukDSR5ZN98Uq1WhuaVE70wFnVh1XNAO1SCA=/sc/1080x1080?spatialTags=0.698000:0.690000,0.572000:0.512000,0.316000:0.468000,0.332000:0.676000,0.166000:0.706000"
}
},
"products": [
{
"id": "s_660_c24444e43a8c685cb1375325690fd56e860c5733cea8595ad60cea1a3c5f41d5",
"name": "Portland Denim Jeans",
"images": [
{
"type": "photo",
"original": {
"link": "https://edge.curalate.com/v1/img/b8R9yk_1eAAhBwceSz3sCO0G0Na8_c7tstWBX1iAJSY="
},
"small": {
"link": "https://edge.curalate.com/v1/img/b8R9yk_1eAAhBwceSz3sCO0G0Na8_c7tstWBX1iAJSY=/w/150"
},
"medium": {
"link": "https://edge.curalate.com/v1/img/b8R9yk_1eAAhBwceSz3sCO0G0Na8_c7tstWBX1iAJSY=/w/300"
},
"large": {
"link": "https://edge.curalate.com/v1/img/b8R9yk_1eAAhBwceSz3sCO0G0Na8_c7tstWBX1iAJSY=/w/600"
},
"extraLarge": {
"link": "https://edge.curalate.com/v1/img/b8R9yk_1eAAhBwceSz3sCO0G0Na8_c7tstWBX1iAJSY=/w/1080"
},
"smallSquare": {
"link": "https://edge.curalate.com/v1/img/b8R9yk_1eAAhBwceSz3sCO0G0Na8_c7tstWBX1iAJSY=/sc/150x150"
},
"mediumSquare": {
"link": "https://edge.curalate.com/v1/img/b8R9yk_1eAAhBwceSz3sCO0G0Na8_c7tstWBX1iAJSY=/sc/300x300"
},
"largeSquare": {
"link": "https://edge.curalate.com/v1/img/b8R9yk_1eAAhBwceSz3sCO0G0Na8_c7tstWBX1iAJSY=/sc/600x600"
},
"extraLargeSquare": {
"link": "https://edge.curalate.com/v1/img/b8R9yk_1eAAhBwceSz3sCO0G0Na8_c7tstWBX1iAJSY=/sc/1080x1080"
}
}
],
"price": {
"display": "125.00"
},
"link": "http://habilimentclothing.myshopify.com/products/the-hippy-denim-jeans",
"metadata": {
"brand": "HabilimentClothing",
"category": "Women",
"isAvailable": "true",
"productId": "the-hippy-denim-jeans"
},
"spatialTag": {
"x": 0.6980000138282776,
"y": 0.6899999976158142,
"label": "1"
}
}
],
"labels": []
}
],
"resultsCount": 36
},
"metadata": {
"traceId": "ac4a4aa9-9c5e-48e7-b43a-780c43a9e0d0"
},
"paging": {
"cursors": {
"after": "3d9f9d4b-529c-4fc3-92b1-53df2ee84492_1487694830638"
},
"next": "https://edge.curalate.com/v1/media/DKQGLerBTQCDXwNS?limit=1 &after=3d9f9d4b-529c-4fc3-92b1-53df2ee84492_1487694830638"
}
}
Updated 5 months ago