pdf2Data SDK with REST API. (4.1+)

Starting with version 4.1, you can now use pdf2Data SDK not only as a native Java/.NET library, or CLI, but also using REST API.

You can find static documentation in SwaggerHub and also play around with the same Swagger UI live when you deploy the application.

Installation

Please follow the instructions below to deploy the pdf2Data SDK service, using Docker:

Pull the Docker image

CODE

docker pull apryse/pdf2data-sdk-service:{version}

You need to explicitly specify the version when using the pull command. e.g. docker pull apryse/pdf2data-sdk-service:4.1.0

Start the Docker image

CODE

docker run -p {host-port}:8080 -e PDF2DATA_SDK_REST_API_AUTH_TOKEN={token} --name {target-container-name} apryse/pdf2data-sdk-service:{version}

where:

{host-port} - the port to which you would like to bind the application to. You can skip this parameter if you don't need to access the service directly from your machine, instead, you might want to use --expose 8080 parameter to access it from another container;
{token} - the access token to be used to authorize the requests to the service, min 16 characters;
{target-container-name} - the name of the container to create;
{version} - the version of the pdf2Data SDK REST service image.

For more options please consult with Docker run command documentation and SDK REST API: Customizing application settings.

Check your installation

You can track the status of the service via http://localhost:{host-port}/api/status/health/ping endpoint and also check the deployed version via http://localhost:{host-port}/api/status/info.

Once the service is up and running you can use Swagger UI to examine what API consists of: http://localhost:{host-port}/api/swagger-ui/index.html.