-
Notifications
You must be signed in to change notification settings - Fork 138
docs: integrate playbook into integrate with apify doc #1608
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 4 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
073f2f2
docs: integrate playbook into integrate with apify doc
TC-MO 435034f
Merge branch 'master' into integration-playbook
TC-MO c254f84
slight restructuring
TC-MO b6c0397
style guide fixes
TC-MO 9b792c1
Apply suggestions from code review
TC-MO 4eb1c77
review fixes & typo fixes
TC-MO 4ff9035
update contact email
TC-MO 7d8b6f1
Apply suggestions from code review
TC-MO 8e33aa8
Merge branch 'master' into integration-playbook
TC-MO File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,25 +1,48 @@ | ||
| --- | ||
| title: Integrate with Apify 🤝 | ||
| title: Integrate with Apify | ||
| sidebar_label: Create new integration | ||
| description: Learn about how to integrate your service with Apify to benefit from a mutual integration. | ||
| sidebar_position: 90.00 | ||
| slug: /integrations/integrate | ||
| --- | ||
|
|
||
| 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 [[email protected]](mailto:[email protected]) 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: | ||
| 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 [[email protected]](mailto:[email protected]) to discuss potential collaboration. We are always looking for ways to make our platform more useful and powerful for our users. | ||
|
|
||
| ## Why integrate with Apify | ||
|
|
||
| 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. | ||
|
|
||
| [Apify Store](https://apify.com/store) contains thousands of pre-built Actors, ready-made tools for webscraping and automations. | ||
TC-MO marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## Integration types | ||
|
|
||
| An Apify integration can be _general_, allowing users to integrate any Actor from 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. | ||
TC-MO marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### General integrations | ||
|
|
||
| General integrations allow users to easily automate workflows by connecting Apify with other platforms. Examples include: | ||
TC-MO marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| - [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. | ||
| - [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). | ||
| - [Make](https://www.make.com/en/integrations/apify) integration enables workflow automation by connecting Apify with thousands of other apps. | ||
TC-MO marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - [Keboola](/platform/integrations/keboola) integration enables Keboola users to easily pull data crawled from the web into their data pipelines. | ||
|
|
||
| and many more that you can see at [integrations](./index.mdx). | ||
| ### Actor-specific integrations | ||
|
|
||
| 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. | ||
TC-MO marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Examples include: | ||
|
|
||
| - [Make Instagram Scraper integration](https://www.make.com/en/integrations/apify-instagram-scraper) | ||
| - [Lindy.ai Instagram integration](https://www.lindy.ai/integrations/instagram) | ||
|
|
||
| For more examples, see [integrations](./index.mdx). | ||
TC-MO marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## Integrating with Apify | ||
|
|
||
| To integrate your service with Apify, you have two options. You can either: | ||
| To integrate your service with Apify, you have two options: | ||
|
|
||
| - build an [Apify Actor](https://docs.apify.com/platform/actors) that will be used as integration within the [Apify Console](https://console.apify.com) | ||
| - build an external integration, such as [Zapier](./workflows-and-notifications/zapier.md). | ||
| - Build an [Apify Actor](https://docs.apify.com/platform/actors) that will be used as integration within [Apify Console](https://console.apify.com) | ||
| - Build an external integration using the [Apify API](https://docs.apify.com/api/v2) | ||
TC-MO marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
|  | ||
|
|
||
|
|
@@ -29,8 +52,151 @@ The best way to reach out to Apify users is directly within [Apify Console](http | |
|
|
||
| ### Building an external integration | ||
|
|
||
| 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. | ||
|
|
||
| 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. | ||
| 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. | ||
|
|
||
|  | ||
|
|
||
| ### Authentication methods | ||
|
|
||
| Apify supports two main authentication methods for secure API access. | ||
|
|
||
| _OAuth 2.0_ - Use OAuth 2.0 to allow users to authorize your integration without sharing their credentials. | ||
TC-MO marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| <!-- TODO expand section possibly? --> | ||
|
|
||
| _API token_ - 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). | ||
|
|
||
| ### API implementation | ||
|
|
||
| To build an integration, core API endpoints can be mapped as **actions and triggers** inside your platform. | ||
|
|
||
| #### Action endpoints | ||
|
|
||
| ##### Run an Actor | ||
|
|
||
| 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. | ||
|
|
||
| Recommended features: | ||
|
|
||
| - 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). | ||
| - Synchronous vs. asynchronous run: flow will wait until the run/task will finish (consider timeout on your platform side) | ||
TC-MO marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - 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. | ||
TC-MO marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - 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). | ||
TC-MO marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - Field mapping: allowing users to map fields to data acquired in previous steps of the workflow | ||
TC-MO marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ##### Run a task | ||
|
|
||
| Starts a predefined task (a saved Actor configuration), making it easy for users to run recurring or templated workflows without redefining inputs each time. | ||
|
|
||
| Recommended features: | ||
TC-MO marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| - 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. | ||
| - Synchronous vs. asynchronous run: flow will wait until the run/task will finish (considering timeout on your platform side) | ||
| - JSON input field: possibility to add JSON input to override the task input. | ||
|
|
||
| ##### Get dataset items | ||
|
|
||
| Fetches structured results (JSON, CSV, etc.) generated by a previously run Actor or task, which can be used as input for further workflow steps. | ||
|
|
||
| Recommended features: | ||
|
|
||
| - Dataset: Dropdown (user's datasets) or ID/String input. Populated via [Datasets API](https://docs.apify.com/api/v2/datasets-get). | ||
| - Limit (optional): The maximum number of dataset items to fetch. If empty, the default limit will be used. | ||
| - Offset (optional): The offset in the dataset from where to start fetching the items. If empty, it will be from the beginning. | ||
|
|
||
| ##### Get key-value store item | ||
TC-MO marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Retrieves a specific item from a key-value store, commonly used to access metadata, snapshots, logs, or one-off results generated during Actor execution. | ||
|
|
||
| Recommended features: | ||
|
|
||
| - 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). | ||
| - Record key: value (string) | ||
|
|
||
| ##### Scrape single URL | ||
TC-MO marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| 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. | ||
TC-MO marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Recommended features: | ||
|
|
||
| - URL: that you intend to scraper (string) | ||
| - Crawler type: Dropdown menu, allowing users to choose from the following options: | ||
| - 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. | ||
TC-MO marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - Stealthy web browser (default) - Another headless web browser with anti-blocking measures enabled. Try this if you encounter anti-bot protections while scraping. | ||
| - 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. | ||
TC-MO marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ##### Universal API call | ||
|
|
||
| A node to send API requests to Apify, allowing advanced users to configure or query Actors, tasks, datasets, or other API endpoints programmatically. | ||
|
|
||
| #### Trigger endpoints | ||
|
|
||
| ##### Watch Actor runs | ||
|
|
||
| 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). | ||
TC-MO marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Recommended features: | ||
|
|
||
| - Select Actor runs to watch: Dropdown (list of user's Actors). Populated via [List Actors API](https://docs.apify.com/api/v2/acts-get) | ||
|
|
||
| ##### Watch task runs | ||
|
|
||
| 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. | ||
|
|
||
| Recommended features: | ||
|
|
||
| - 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). | ||
|
|
||
| ### Pricing options | ||
|
|
||
| Choose between two pricing models based on your integration setup. | ||
|
|
||
| #### Direct user billing | ||
|
|
||
| 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. | ||
|
|
||
| #### Whitelabel access | ||
|
|
||
| Users access Apify through your platform without needing an Apify account. Apify bills you based on consumption, and you factor costs into your pricing. | ||
|
|
||
| ### Monitoring and tracking | ||
|
|
||
| To help Apify monitor and support your integration, every API request should identify your platform. You can do this in one of two ways: | ||
|
|
||
| - Preferred: | ||
| - Use the `x-apify-integration-platform` header with your platform name (e.g., make.com, zapier). | ||
| - If your platform has multiple Apify apps, also include the `x-apify-integration-app-id` header with the unique app ID. | ||
| - Alternative: | ||
| - Set a custom `User-Agent` header that identifies your platform. | ||
|
|
||
| These identifiers enable better analytics and support for your integration. | ||
|
|
||
| ## Technical resources | ||
|
|
||
| ### Apify API | ||
|
|
||
| [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. | ||
TC-MO marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| - [Apify API Reference](https://docs.apify.com/api/v2) | ||
| - Client Libraries | ||
TC-MO marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - [JavaScript/TypeScript/Node.js](https://docs.apify.com/api/client/js/) | ||
| - [Python](https://docs.apify.com/api/client/python/) | ||
|
|
||
| ### Reference implementations | ||
|
|
||
| For inspiration, take a look at the public repositories of our existing external integrations: | ||
TC-MO marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| - Zapier | ||
| - [Zapier integration documentation](https://docs.apify.com/platform/integrations/zapier) | ||
| - [Source code on Github](https://github.com/apify/apify-zapier-integration) | ||
| - Make.com | ||
| - [Make.com integration documentation](https://docs.apify.com/platform/integrations/make) | ||
| - Keboola | ||
| - [Keboola integration documentation](https://docs.apify.com/platform/integrations/keboola) | ||
| - [Source code on Github](https://github.com/apify/keboola-ex-apify/) (JavaScript) | ||
TC-MO marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - [Google Maps Reviews Scraper integration](https://github.com/apify/keboola-gmrs/) (Actor-specific) | ||
| - Airbyte | ||
| - [Source code on Github](https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-apify-dataset) (Python) | ||
TC-MO marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - Pipedream | ||
| - [Source code on Github](https://github.com/PipedreamHQ/pipedream/tree/65e79d1d66cf0f2fca5ad20a18acd001f5eea069/components/apify) | ||
TC-MO marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| For technical support, contact us at [[email protected]](mailto:[email protected]). | ||
TC-MO marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.