Asynchronous HTTP Retriever Documentation

Service for retrieving HTTP resources asynchronously. Self-hosted within a lovely collection of docker containers.

Send a POST request containing url, callback, (optionally) header and (optionally) parameter values. Content for the given url will be retrieved eventually and sent in a POST request to the specified callback url.

Everything becomes clear if you read the overview. There is even a handy diagram.

Requirements

You’ll need docker and docker-compose present on the host box. If you can run docker, you can run this application. Nothing else needed.

Developed and tested against docker 18.06.1-ce and docker-compose 1.22.0.

First Steps

Have a look at the getting started guide for details on how to get the code, create your configuration and install an instance.

Requests And Callbacks

• Request-Response Cycle
• Requesting a Resource
  • Making a Request
    • Parameters
    • Curl Example Without Headers
    • Curl Example With Headers
  • Specifying Cookie Parameters
  • Understanding The Response
    • Successful Request (200)
    • Bad Request (400)
• Callback Responses
  • Response Object Properties
  • Success Response Example
  • HTTP Failure Example (404 Not Found)
  • HTTP Failure Example (301)
  • Curl Failure Example (Operation Timed Out)
  • Unknown Failure Example

Reference

• Upgrading
  • Zero-downtime Upgrading
  • Creating the Second Instance (instance-y)
  • Configure Applications to Use instance-y
  • Removing the First Instance
• Configuration
  • Creating your configuration file
  • Configuration You Must Set
  • Configuration You Should Set
  • Configuration You Can Optionally Set