Developers kit (API)

The Picario visualization engine can be used as a tool for developing your own (visualization) solutions. Picario XPO’s Developer API enables you to implement our software in your own website. This allows you to create your own configurator with your costum design and lay-out.

When you run into any trouble while building your own website with picario implementation, our programmers are available to help you with technical issues. Contact us for more information about Picario API. The PicarioXPO API consists of two parts: the render API and the data API. The first is, as the name says, all about the rendering of scenes with their objects.

Render API

Generating render URL’s can be quite a task because of all the variables and different options. Because of that we’ve created an SDK for JavaScript and C# users. This SDK contains a Fluent interface which you can use to create URL’s for your application.

Data APIThe data API is used for getting all the data from XPO via an easy to use API. You can get a single entity, a list of entities, a texture, a lot of textures, everything in JSON.

When building a visualization solutions using our engine, our supportteam and developers are stand-by to guide you through the process and answer any questions you might have.

PicarioXPO Development Kit FAQ

Q1: What is a scene file?

A scene file (.pfs file format) is our Picario Face Scene file format. A scene file contains a JPG or PNG image that has been prepared by us and can be used to add colors, textures, logo’s, and more. These scene files are also called master images.

Q2: We are experiencing time out errors on the platform, what's wrong?

Most of the time this is a cache issue. To increase the performance of your PicarioXPO account we suggest using an unique SUI id in every URL request. If you are still experiencing problems, please contact as at info@picario.com

Q3: What is a texture?

Multiple things can be used as textures on our PicarioXPO. We have our Picario Face Texture format (.pft) that contains an image and also already contains the correct information on the positioning, the dimensions, the repeat, etc. You can also use seperate images, like logos, as textures. The dimensions, the positioning, the repeat and more of image files can be set in the URL using different parameters. Our manual gives more information on the use of textures.

Q4: We need to use a very high font size in some images, how come?

The surfaces that are defined within the master image are in centimeters, for example a floor of a living room can be 400cm width and 800cm long. The Picario engine uses these dimensions to create a realistic visualization based on the dimensions in the textures. These dimensions are used to calculate the needed dimensions of the text, because of this you will have to look for a suitable font size depending on the dimensions specified for the objects in the master image.

Q5: Can I use my own images?

Yes, of course! We prepare your product images to our scene file format so you can make unlimited variations of the image using our platform. You only pay for the creation of the master images. There is not extra fee for the creation of all the variations you make using our platform with different colors, textures, logo and more.

Q6: When we are requesting a scene we get the following error “Unexpected error: FACE Return Code Error on Function 'ReadScene': 11 - Unexpected end of file”. Please help?

In most cases this means the scene file (the master image) you are requesting is corrupt. This can occur when an FTP transfer failed to upload the complete scene. The request should work when you upload the scene file to the FTP again. If the problems keep occurring you can check if the scene file works in our Face Designer software or you can send the scene file to info@picario.com and we will take a look at it.

Q7: What image formats are supported?

The file formats that our PicarioXPO supports are JPG and PNG. The output of the visualized images are also JPG (with compression that you can control using the quality parameter) and PNG depending on the selected output parameter in the URL.

Q8: Can I use transparent PNG images as master images?

It is possible to change the output of a scene file in PicarioXPO to the PNG format. The image inside a scene file is always in the JPG format. However Picario can use the transparant alpha mask from a PNG file to create transparancy in scene files and change the output image to PNG format. Transparant PNG files can also be used as textures and to stack images using the URL request. Please see PicarioXPO manual for more information.

Q14: I have a master image that contains multiple linked objects in different dimensions. When I add an web image to the texture object using the URL request the texture is displayed in different sizes and the placement is not correct.

Picario uses the dimensions specified in both the texture files and the scene files to create the visualized end result. A web image doesn’t have prespecified dimensions so the results may vary. To fix this problem you have to enter the same size for the objects in the master image even if the size in pixels might be different. The web image will be scaled to fit the object resulting in a realistic visualization.

Q10: Can I use images that originate from a different source like another website?

Yes, you can use images from another website. Just enter the URL of the desired image at the end of the parameters used for the specific object in the scene. For example "&tn1=http://www.yourimages.com/image1.jpg".

Q11: Can't I just prepare the scene files myself?

It is possible to create your own scene files using our FACE Creator software. Please contact us at info@picario.com for more information or a 30 day free trial version.

Q12: Can I recolor a texture in real-time on the web?

Yes, it is possible to recolor a texture and use the recolored texture in the master image to create a visualized image. You do this by using two request and using the first request as a texture in the second request. For example, the first request will be a scene file (master image) of a wooden floor that you request in a different color. You then use the URL of the recolored floor as a texture in the second master image of for example a living room. You will have to use a encoded version of the first URL request inside the second URL request, in order for it to work.

Q13: Is the quality of the generated images suitable for Printed Media?

The quality of the visualized/generated images depends on the original quality of the images. If you have high resolution images of your products that are suitable for print, we can prepare those to our scene file format. Keep in mind that these images are not suitable for web usage due to the large file sizes. If you want to use the same product images on your website or webshop the scene files can be scaled to a smaller resolution to speed up the online performance.

Q9: What are the costs of preparing my product images to the scene file format?

The price per product image depends on your wishes and on the product itself. Some products take more time to prepare, for example the preparation of curtains are more complex than flat surfaces like floors and walls. Feel free to send us examples of your product images so we can give you a quotation on the preparation costs.

Q15: Do I need to install any plugins to integrate Picario in my own website or webshop in for example Magento?

No, plugins are needed to add our PicarioXPO to your website or webshop. Picario is an URL API which integrates easily into any website or webshop. It integrates as if you would add a normal image to your website/webshop. Please see our manual for more information.

Q16: My visualized images are a little unsharp, can I change this?

Yes, you can. Picario automatically decreases the output quality for a better performance. You can add the parameter "&q=100" or "&q=90" to your request for a better image quality. The quality difference between 100 and 90 is very small but performance wise this can make a huge difference.

Q17: The requested images are loading slow the first time, is there a way to increase the performance?

Yes, there are several solutions, but the most common one is changing the size of the master images. For example if you are using a web version of your image in an output size of 500x500 pixels but your master image has a size of 6000x6000 pixels Picario will first have to download the original image and will scale the output. This takes time. The best solution is to use the ‘save scaled’ feature in the Face Creator software, to create a smaller version of the scene you want to use on the web.

Q18: We are experiencing time out errors on the platform, what's wrong?

Most of the time this is a cache issue. To increase the performance of your PicarioXPO account we suggest using an unique SUI id in every URL request. If you are still experiencing problems, please contact as at info@picario.com