VintaSoft Imaging Web services
In This Topic
VintaSoft Imaging .NET SDK provides
VintaSoft Imaging JavaScript API, which contains JavaScript classes and JavaScript UI-controls, which can be used on the client-side of web application.
Also VintaSoft Imaging .NET SDK provides
VintaSoft Imaging Web services, which contain 4 types of web services: ready-to-use platform-independent web services; ASP.NET Core Web API controllers; ASP.NET Web API controllers; ASP.NET HTTP handlers.
VintaSoft Imaging JavaScript API uses
VintaSoft Imaging Web services when server-side operation (document loading, image/page rendering, image processing, file conversion, document saving, ...) is necessary.
Which ready-to-use VintaSoft Imaging Web services I can use in ASP.NET Core Web application?
VintaSoft Imaging .NET SDK provides the following ASP.NET Core Web API controllers for usage in in ASP.NET Core Web application:
Which ready-to-use VintaSoft Imaging Web services I can use in ASP.NET MVC5 Web application?
VintaSoft Imaging .NET SDK provides the following ASP.NET Core Web API controllers for usage in in ASP.NET Core Web application:
Which ready-to-use VintaSoft Imaging Web services I can use in ASP.NET WebForms Web application?
VintaSoft Imaging .NET SDK provides the following ASP.NET Core Web API controllers for usage in in ASP.NET Core Web application:
- VintasoftFileHandler - ASP.NET HTTP handler that handles HTTP requests from clients and allows to manipulate files on a server.
- VintasoftFileConverterHandler - ASP.NET HTTP handler that handles HTTP requests from clients and allows to convert an image/document file.
- VintasoftImageHandler - ASP.NET HTTP handler that handles HTTP requests from clients and allows to get information about image or render image thumbnail/tile.
- VintasoftImageCollectionHandler - ASP.NET HTTP handler that handles HTTP requests from clients and allows to manage an image collection.
- VintasoftImageProcessingHandler - ASP.NET HTTP handler that handles HTTP requests from clients and allows to process an image.
- VintasoftImageProcessingDocCleanupHandler - ASP.NET HTTP handler that handles HTTP requests from clients and allows to process a document image.
- VintasoftAnnotationCollectionHandler - ASP.NET HTTP handler that handles HTTP requests from clients and allows to annotate images.
- VintasoftPdfHandler - ASP.NET HTTP handler that handles HTTP requests from clients and allows to work with PDF documents.
- VintasoftOfficeHandler - ASP.NET HTTP handler that handles HTTP requests from clients and allows to work with Office documents.
- VintasoftDicomHandler - ASP.NET HTTP handler that handles HTTP requests from clients and allows to work with DICOM files.
What is the VintaSoft Imaging platform-independent web service?
VintaSoft Imaging platform-independent web service is 100% managed .NET service and it does not depend from any web platform.
The VintaSoft Imaging platform-independent web service is used as a core for VintaSoft Imaging platform-dependent web service (ASP.NET Core Web API controller; ASP.NET Web API controller; ASP.NET HTTP handler).
Here is the list of VintaSoft Imaging platform-independent web services:
Where does the VintaSoft Imaging Web service store files?
By default each VintaSoft Imaging Web service stores files in the following directories:
- Uploaded files are stored in "{WebAppRoot}/UploadedImageFiles/{SessionId}" directory
- Cache files are stored in "{WebAppRoot}/VintasoftCache/{SessionId}" directory
- Resource files are stored in "{WebAppRoot}/Resources}" directory
Files are stored in the root directory of web application because some files should have public access, for example, rendered image tile should be accessible to a web browser (client side).
Where does the VintaSoft Imaging Web service store uploaded files?
Uploaded files are source files, which are copied or uploaded by user and are used in current web session.
By default each VintaSoft Imaging Web service stores uploaded files in "{WebAppRoot}/UploadedImageFiles/{SessionId}" directory.
Where does the VintaSoft Imaging Web service store cache files?
Cache files are temporary files, which are created by VintaSoft Imaging Web service and are used for cache purposes.
By default each VintaSoft Imaging Web service stores cache files in "{WebAppRoot}/VintasoftCache" directory:
- Cache of image tiles is stored in "{WebAppRoot}/VintasoftCache/{SessionId}/Tiles" directory
- Cache of thumbnails is stored in "{WebAppRoot}/VintasoftCache/{SessionId}/Thumbnails" directory
- Cache of annotations is stored in "{WebAppRoot}/VintasoftCache/{SessionId}/Annotations" directory
- Cache of serialized documents is stored in "{WebAppRoot}/VintasoftCache/{SessionId}/SerializedDocuments" directory
- Cache of converted files is stored in "{WebAppRoot}/VintasoftCache/{SessionId}/ConvertedFiles" directory
Where does the VintaSoft Imaging Web service store resource files?
Resource files are files, which contain resources, which are used by VintaSoft Imaging Web service. Resource files are prepared by the application developer.
By default each VintaSoft Imaging Web service stores resource files in "{WebAppRoot}/Resources" directory.
Can I store all uploaded files of VintaSoft Imaging Web service in "{WebAppRoot}/UploadedImageFiles" directory?
Yes, you can store all uploaded files of VintaSoft Imaging Web service in "{WebAppRoot}/UploadedImageFiles" directory. Please do the following steps:
-
Specify that you want to use empty session identifier.
Here is necessary JavaScript/TypeScript code: Vintasoft.Shared.WebImagingEnviromentJS.set_SessionId('');
-
Specify that VintaSoft Imaging Web service allows to use empty session.
This can be done using the IsEmptySessionSupported property in VintaSoft Imaging Web service, for example, using the VintasoftImageApiController.IsEmptySessionSupported property.
Can I use the same custom directory for uploaded files for all VintaSoft Imaging Web services?
Yes, this is possible. Please do the following steps:
Can I use the same custom directory for cache files for all VintaSoft Imaging Web services?
Yes, this is possible. The
WebServicesGlobalSettings.DataDirectoryDefaultPath property allows to set path to a directory, where all VintaSoft Imaging Web services will store data files.
If path points to a directory in the root directory of web application, no additional actions are necessary.
If path points to a directory outside the root directory of web application, the following additional actions are necessary:
-
Specify that web image viewer should use base64-images for image tiles. This is necessary because web browser cannot access image tiles outside the root directory of web application.
Here is necessary JavaScript/TypeScript code: imageViewer1.set_TilesFormat("Base64");
-
Specify that web thumbnail viewer should use base64-images for thumbnails. This is necessary because web browser cannot access thumbnails outside the root directory of web application.
Here is necessary JavaScript/TypeScript code: thumbnailViewer1.set_ThumbnailsFormat("Base64");
Can I use the same custom directory for resource files for all VintaSoft Imaging Web services?
Yes, this is possible. Please do the following steps: