anubhav-mahajan / doc-to-img-converter

This API helps in converting uploaded documents to images based on options provided.

Document to image converter

With this API you will be able to convert any document to image.

doc-to-img-converter's Issues

Create Document to Image conversion api

Background

Client has a requirement where in an API needs to be exposed which will do a basic conversion of a document to Image based on some parameters. The document can be of type pdf, doc or docx and the converted image for each page should be either a png or a jpg file. The parameters could be some options which could be specific to image resolution like DPI and quality. The API should also have a authentication mechanism, so that it can be securely hosted.

Requirement

• #2
• The API could be hosted in any environment Windows, Linux or MacOS.
• An API should be exposed for end user to consume. It should allow the consumer to upload the file using http post request with some options.
• The API should have a configurable path on the server where the images are stored.
• Expose other API to help user download the converted files, if they need it. (Could be a part of future scope.)

Design flow diagram

Create a authentication mechanism, this could be some token based authentication.

Background

In order to use API in a production environment, hash-based message authentication code is required. Access Key authentication uses a hash-based message authentication code (HMAC) to uniquely sign a single HTTP request. This method is intended for non-interactive users (technical users) who are involved in software-to-software or system-to-system authentication scenarios.

Access keys are comprised of two parts: a secret key and a shared key.
The scheme used in the Authorization header is AccessKey <shared-key>:<hmac>.

Advantages

There are some advantages to HMAC authentication, such as:

• It allows maintenance of a single platform identity with multiple credentials expressed in the form of access keys.
• Individual access keys can be disabled or deleted without affecting other keys or the identity itself.
• The secret key never expires, which simplifies interaction with the platform as compared to using temporary access tokens.
• This method guarantees authenticity of the full request instead of a specific part of the request (such as the Authorization header).
• Actual user secrets are never transmitted over the wire as each request has a unique HMAC.