Example Web Server avatar

Example Web Server

Try for free

No credit card required

Go to Store
Example Web Server

Example Web Server

apify/example-web-server
Try for free

No credit card required

This example demonstrates how to use web server in actor as communication channel with outer world. Read more at Apify docs https://docs.apify.com/actors/running#container-web-server

Do you want to learn more about this Actor?

Get a demo

You can access the Example Web Server programmatically from your own applications by using the Apify API. You can choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in Integrations settings in Apify Console.

1# Set API token
2API_TOKEN=<YOUR_API_TOKEN>
3
4# Prepare Actor input
5cat > input.json << 'EOF'
6{}
7EOF
8
9# Run the Actor using an HTTP API
10# See the full API reference at https://docs.apify.com/api/v2
11curl "https://api.apify.com/v2/acts/apify~example-web-server/runs?token=$API_TOKEN" \
12  -X POST \
13  -d @input.json \
14  -H 'Content-Type: application/json'

Example Web Server API

Below, you can find a list of relevant HTTP API endpoints for calling the Example Web Server Actor. For this, you’ll need an Apify account. Replace <YOUR_API_TOKEN> in the URLs with your Apify API token, which you can find under Integrations in Apify Console. For details, see the API reference .

Run Actor

POST
https://api.apify.com/v2/acts/apify~example-web-server/runs?token=<YOUR_API_TOKEN>

Note: By adding the method=POST query parameter, this API endpoint can be called using a GET request and thus used in third-party webhooks. Please refer to our Run Actor API documentation .

Run Actor synchronously and get dataset items

POST
https://api.apify.com/v2/acts/apify~example-web-server/run-sync-get-dataset-items?token=<YOUR_API_TOKEN>

Note: This endpoint supports both POST and GET request methods. However, only the POST method allows you to pass input data. For more information, please refer to our Run Actor synchronously and get dataset items API documentation .

Get Actor

GET
https://api.apify.com/v2/acts/apify~example-web-server?token=<YOUR_API_TOKEN>

For more information, please refer to our Get Actor API documentation .

Actors can be used to scrape web pages, extract data, or automate browser tasks. Use the Example Web Server API programmatically via the Apify API.

You can choose from:

You can start Example Web Server with the Apify API by sending an HTTP POST request to the Run Actor endpoint. An Actor’s input and its content type can be passed as a payload of the POST request, and additional options can be specified using URL query parameters. The Example Web Server is identified within the API by its ID, which is the creator’s username and the name of the Actor.

When the Example Web Server run finishes you can list the data from its default dataset (storage) via the API or you can preview the data directly on Apify Console .

Developer
Maintained by Apify

Actor Metrics

  • 2 monthly users

  • 4 stars

  • 38 days response time

  • Created in Jul 2018

  • Modified 6 months ago

Categories