Home Page > Integration > URL Links

URL Links

URL Links

Using some fixed URL formats you can link directly to pages in OpenAsset.

 

Search Links

Links to pages of search results can be created with a URL of the form:
http://example.com/Page/SearchLink?categoryCode=Projects
 
Optionally projectCode or keywords can also be added to the URL.
 
The keywords parameter is equivalent to entering text in the keywords box on the left hand search panel. i.e. it searches the keywords and also the filename, original filename, caption and description.
 
Search for a keyword - 
http://example.com/Page/SearchLink?categoryCode=Reference&keywords=office
 
Search for a keyword across all projects - 
http://example.com/Page/SearchLink?categoryCode=Projects&keywords=office
 
Search for all images in a project - 
http://example.com/Page/SearchLink?categoryCode=Projects&projectCode=AXO001
 
Search for a keyword in a project - 
http://example.com/Page/SearchLink?categoryCode=Projects&projectCode=AXO001&keywords=office
 
Album Links - To link directory to a view of the images in an album you can use a URL of the form:
http://example.com/Page/AlbumLink?code=fd4e2020c2e3134a21b45bb8fc3984cb
Please see Appendix 1 to find the code for an album.
 
Image Links - To link to the details page of a specific image you can use a URL of the form: 
http://example.com/Page/ImageLink?filename=AXO001_N1.jpg
 
Project Links - To link directory to a summary page of the images in a project you can use a URL of
the form: 
http://example.com/Page/ProjectLink?projectCode=AXO001
 

oEmbed Representations of a URL

oEmbed is a technology used for displaying an enhanced representation of a URL.  e.g. Rather than just a a text based link to the details page of an image in OpenAsset, you can display a thumbnail of the image itself. oEmbed is used to retrieve all the necessary details to display the thumbnail using an standard open format. 
For more details see: http://www.oembed.com
 

URL endpoint and supported parameters

The endpoint for retrieving oEmbed data is of the form: http://example.com/Feed/OEmbed
 
The following parameters are supported:
url required
Address you wish to represent (must be
URL encoded)
format optional
Either json or xml
Default is json
maxwidth optional
Maximum width of a thumbnail or video
used to represent the URL
maxheight optional
Maximum height of a thumbnail or
video used to represent the URL

 

Supported URLs

Image - oEmbed data can be generated for links to file detail pages of the form:

http://example.com/Page/ImageLink?filename=A2_N4.jpg
Links of this form can be found in Search or Album RSS feeds.
 
Project - oEmbed data can be generated for links to project overview pages of the form:
http://example.com/Page/ProjectLink?code=1234
 

Formats

Data can be returned in either JSON or XML format. The default format is currently JSON, although it is always best to explicitly specify the format you require.

 

Photo in JSON format

http://example.com/Feed/OEmbed?format=json&url=http://example.com/Page/ImageLink%3Ffilename%3DA2_N4.jpg

 

Photo in XML format

http://example.com/Feed/OEmbed?format=xml&url=http://example.com/Page/ImageLink%3Ffilename%3DA2_N4.jpg&maxwidth=400

 

Video - If the file associated with a URL is a video and an MP4 preview file has been generated, HTML will be retuerned that can be directly embedded in a web page to play the video.

 

 
Link - If no image or video is associated with a link, a link type response is returned.
http://example.com/Feed/OEmbed?format=xml&url=http://openasset/Page/ImageLink%3Ffilename%3DRE_110310_N10.rfa

 

<?xml version="1.0" encoding="iso-8859-1"?>
<oembed>
 <version>1.0</version>
 <type>link</type>
 <title>RE_110310_N10.rfa</title>
 <author></author>
 <author_url></author_url>
 <provider>OpenAsset</provider>
 <provider_url>http://www.axomic.com</provider_url> 
</oembed>

 

 

Appendix 1 - Possible values for fields

categoryCode

Some APIs require a value for categoryCode to identify the category of images being referred to (e.g. see Search Links or Search RSS Feeds).
 
The values to be used for categoryCode can be found on the edit category page
 

Album:code

To find the code for an album you can click on the “edit” link on a list of albums.
 

Related

Topics
Create and Edit Projects
Integration
OpenAsset comes delivered with many tools for integrating into your existing systems. In some cases it may be necessary to use the APIs provided by Axomic to perform bespoke development work.
SharePoint Integration
SOAP API
XML and RSS
References
Last modified
04:39, 11 Jan 2016

Tags

Classifications

This page has no classifications.