You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: Learn about how to integrate your service with Apify to benefit from a mutual integration.
5
5
sidebar_position: 90.00
6
6
slug: /integrations/integrate
7
7
---
8
8
9
-
If you are building a service and your users could benefit from integrating with Apify or vice versa, we would love to hear from you! Contact us at [partners@apify.com](mailto:partners@apify.com) to discuss potential collaboration. We are always looking for ways to make our platform more useful and powerful for our users. Here are some examples of services and tools integrating with Apify:
9
+
If you are building a service and your users could benefit from integrating with Apify or vice versa, we would love to hear from you! Contact us at [partners@apify.com](mailto:partners@apify.com) to discuss potential collaboration. We are always looking for ways to make our platform more useful and powerful for our users.
10
+
11
+
## Why integrate with Apify
12
+
13
+
Apify is the leading platform for web scraping, AI agents, and automation tools. By integrating Apify into your platform, you enable users to incorporate real-time, structured data from the web with zero scraping infrastructure on your side.
14
+
15
+
The [Apify Store](https://apify.com/store) contains thousands of pre-built Actors, ready-made tools for webscraping and automations.
16
+
17
+
## Integration types
18
+
19
+
An Apify integration can be _general_, allowing users to integrate any Actor from the Apify Store into their workflows (or their own Actors), or _Actor-specific_, enabling targeted automation like integrating the [Instagram Scraper](https://apify.com/apify/instagram-scraper) for use cases like social media monitoring.
20
+
21
+
### General integrations
22
+
23
+
General integrations allow users to easily automate workflows by connecting Apify with other platforms. Examples include:
10
24
11
-
-[Langchain](./ai/langchain.md) integration enables developers to build their projects, such as AI chatbots, with Langchain to feed them with data from the web easily.
12
25
-[Zapier](./workflows-and-notifications/zapier.md) integration allows Zapier users to enrich their automation workflows with data from the web or to add additional Actions performed by [Apify Actors](https://apify.com/store).
26
+
-[Make](https://www.make.com/en/integrations/apify) integration enables workflow automation by connecting Apify with thousands of other apps.
13
27
-[Keboola](/platform/integrations/keboola) integration enables Keboola users to easily pull data crawled from the web into their data pipelines.
14
28
15
-
and many more that you can see at [integrations](./index.mdx).
29
+
### Actor-specific integrations
30
+
31
+
Actor-specific integrations enable integrating specific Actors for targeted use cases. While they offer similar functionality to general integrations, they make it easier for users searching for specific use cases to discover Apify's tools and enjoy a more streamlined experience.
@@ -29,8 +52,155 @@ The best way to reach out to Apify users is directly within [Apify Console](http
29
52
30
53
### Building an external integration
31
54
32
-
Alternatively, you can let your users manage the connection directly on your side using [Apify API](https://docs.apify.com/api/v2) and our API clients for [JavaScript](/api/client/js/) or [Python](/api/client/python/). This way, you can provide a seamless experience for your users and let them manage the connection directly from your service.
33
-
34
-
For inspiration, take a look at the public repositories of our existing external integrations [Zapier](https://github.com/apify/apify-zapier-integration) or [Keboola](https://github.com/apify/keboola-ex-apify) both done in JavaScript or [Airbyte](https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-apify-dataset) written in Python.
55
+
Alternatively, you can let your users manage the connection directly on your side using [Apify API](https://docs.apify.com/api/v2) and our API clients for [JavaScript](/api/client/js/) or [Python](/api/client/python/). This way, your users can manage the connection directly from your service.
Apify supports two main authentication methods for secure API access.
62
+
63
+
#### OAuth 2.0
64
+
65
+
Use OAuth 2.0 to allow users to authorize your integration without sharing their credentials.
66
+
<!-- TODO expand section possibly? -->
67
+
68
+
#### API Token
69
+
70
+
Apify user generates personal API token from Apify account settings page. For more information, see [API Token documentation](https://docs.apify.com/platform/integrations/api#api-token).
71
+
72
+
### API implementation
73
+
74
+
To build an integration, core API endpoints can be mapped as **actions and triggers** inside your platform.
75
+
76
+
#### Action endpoints
77
+
78
+
##### Run an Actor
79
+
80
+
Triggers the execution of any Apify Actor by ID, allowing users to start custom or public web scraping and automation Actors with specified input parameters.
81
+
82
+
Recommended features:
83
+
84
+
- Select Actor: The Actor list will be pre-populated with Actors that the user created or used, using the [List of Actors API](https://docs.apify.com/api/v2/acts-get) and enriched with Actors from the store, which the user has not run already using [API](https://docs.apify.com/api/v2/store-get).
85
+
- Synchronous vs. asynchronous run: flow will wait until the run/task will finish (consider timeout on your platform side)
86
+
- Input UI: upon selecting an Actor, dynamically display specific Actor input and preload default example values based on Actor Input schema. Alternatively, allow users to insert a JSON input for the Actor.
87
+
- Additionally, it should include option to choose [Actor build](https://docs.apify.com/platform/actors/running/runs-and-builds), [memory](https://docs.apify.com/platform/actors/running/usage-and-resources#memory) and [timeout](https://docs.apify.com/platform/actors/running/usage-and-resources#memory).
88
+
- Field mapping: allowing users to map fields to data acquired in previous steps of the workflow
89
+
90
+
##### Run a task
91
+
92
+
Starts a predefined task (a saved Actor configuration), making it easy for users to run recurring or templated workflows without redefining inputs each time.
93
+
94
+
Recommended features:
95
+
96
+
- Select task: The task list will be pre-populated with tasks that the user created, using the [List of tasks](https://docs.apify.com/api/v2/actor-tasks-get) API.
97
+
- Synchronous vs. asynchronous run: flow will wait until the run/task will finish (considering timeout on your platform side)
98
+
- JSON input field: possibility to add JSON input to override the task input.
99
+
100
+
##### Get dataset items
101
+
102
+
Fetches structured results (JSON, CSV, etc.) generated by a previously run Actor or task, which can be used as input for further workflow steps.
103
+
104
+
Recommended features:
105
+
106
+
- Dataset: Dropdown (user's datasets) or ID/String input. Populated via [Datasets API](https://docs.apify.com/api/v2/datasets-get).
107
+
- Limit (optional): The maximum number of dataset items to fetch. If empty, the default limit will be used.
108
+
- Offset (optional): The offset in the dataset from where to start fetching the items. If empty, it will be from the beginning.
109
+
110
+
##### Get key-value store item
111
+
112
+
Retrieves a specific item from a key-value store, commonly used to access metadata, snapshots, logs, or one-off results generated during Actor execution.
113
+
114
+
Recommended features:
115
+
116
+
- Key-value store: Dropdown (user's KV stores) or ID/String input. Populated via [Key-value Stores API](https://docs.apify.com/api/v2/key-value-stores-get).
117
+
- Record key: value (string)
118
+
119
+
##### Scrape single URL
120
+
121
+
Runs Apify's [Website Content Crawler](https://apify.com/apify/website-content-crawler) Actor in synchronous mode to extract structured data from a single web page—ideal for on-demand URL scraping inside agents or automation flows.
122
+
123
+
Recommended features:
124
+
125
+
- URL: that you intend to scraper (string)
126
+
- Crawler type: Dropdown menu, allowing users to choose from the following options:
127
+
- Headless web browser - Useful for modern websites with anti-scraping protections and JavaScript rendering. It recognizes common blocking patterns like CAPTCHAs and automatically retries blocked requests through new sessions.
128
+
- Stealthy web browser (default) - Another headless web browser with anti-blocking measures enabled. Try this if you encounter anti-bot protections while scraping.
129
+
- Raw HTTP client - High-performance crawling mode that uses raw HTTP requests to fetch the pages. It is faster and cheaper, but it might not work on all websites.
130
+
131
+
##### Universal API call
132
+
133
+
A node to send API requests to Apify, allowing advanced users to configure or query Actors, tasks, datasets, or other API endpoints programmatically.
134
+
135
+
#### Trigger endpoints
136
+
137
+
##### Watch Actor runs
138
+
139
+
Monitors the status of an Actor run by ID, useful for triggering follow-up steps once a job has completed. Triggered when a specific Actor run reaches a terminal status (succeeded, failed, timed out, aborted).
140
+
141
+
Recommended features:
142
+
143
+
- Select Actor runs to watch: Dropdown (list of user's Actors). Populated via [List Actors API](https://docs.apify.com/api/v2/acts-get)
144
+
145
+
##### Watch task runs
146
+
147
+
Similar to watching Actor runs, this tracks the progress and completion status of a specific task run to allow event-driven actions in a workflow.
148
+
149
+
Recommended features:
150
+
151
+
- Select Actor tasks to watch: Dropdown (list of user's tasks). Populated via [List tasks API](https://docs.apify.com/api/v2/actor-tasks-get).
152
+
153
+
### Pricing options
154
+
155
+
Choose between two pricing models based on your integration setup.
156
+
157
+
#### Direct user billing
158
+
159
+
Users create their own Apify accounts and are billed directly by Apify for their usage. This model gives users full control over their Apify usage and billing.
160
+
161
+
#### Whitelabel access
162
+
163
+
Users access Apify through your platform without needing an Apify account. Apify bills you based on consumption, and you factor costs into your pricing.
164
+
165
+
### Monitoring and tracking
166
+
167
+
To help Apify monitor and support your integration, every API request should identify your platform. You can do this in one of two ways:
168
+
169
+
- Preferred:
170
+
- Use the `x-apify-integration-platform` header with your platform name (e.g., make.com, zapier).
171
+
- If your platform has multiple Apify apps, also include the `x-apify-integration-app-id` header with the unique app ID.
172
+
- Alternative:
173
+
- Set a custom `User-Agent` header that identifies your platform.
174
+
175
+
These identifiers enable better analytics and support for your integration.
176
+
177
+
## Technical resources
178
+
179
+
### Apify API
180
+
181
+
[Apify API](https://docs.apify.com/api) provides extensive REST API, which covers all of the features of the Apify platform. You can download the complete OpenAPI schema of Apify API in the [YAML](https://docs.apify.com/api/openapi.yaml) or [JSON](https://docs.apify.com/api/openapi.json) formats. Apify provides official libraries for JavaScript and Python to access API.
182
+
183
+
-[Apify API Reference](https://docs.apify.com/api/v2)
0 commit comments