Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
63 commits
Select commit Hold shift + click to select a range
078a71b
feat: Updating integrations section
valekjo Mar 7, 2023
42c899a
Progress
valekjo Mar 8, 2023
735b1fe
lint fix
valekjo Mar 8, 2023
b6106ec
Change nvmrc to 16
valekjo Mar 8, 2023
4e501d2
Merge branch 'master' into feature/513-rewrite-integrations-section
valekjo Mar 16, 2023
b14e914
Update urls
valekjo Mar 16, 2023
96c6bba
Added more or less empty pages for hevo and transposit
valekjo Mar 16, 2023
2ef7072
Merge branch 'master' of github.com:apify/apify-docs into feature/513…
mtrunkat Mar 21, 2023
654db12
Suggesting the format
mtrunkat Mar 21, 2023
81642e0
Typo
mtrunkat Mar 21, 2023
f8a0e75
Merge pull request #554 from apify/feature/mara_suggestions
valekjo Mar 29, 2023
49fbc10
Merge branch 'master' into feature/513-rewrite-integrations-section
valekjo Mar 29, 2023
df53f87
Progress
valekjo Mar 29, 2023
b010412
Touches
valekjo Apr 4, 2023
ed6b6c2
Merge branch 'master' into feature/513-rewrite-integrations-section
valekjo Apr 4, 2023
60a37d3
Include langchain info
valekjo Apr 4, 2023
9886e1e
Rename card component
valekjo Apr 4, 2023
16d78d5
Index updates
valekjo Apr 4, 2023
da2b2ec
Small touches to individual integrations
valekjo Apr 4, 2023
1da34d3
Update api section
valekjo Apr 4, 2023
73b08ed
Merge branch 'master' into feature/513-rewrite-integrations-section
valekjo Apr 4, 2023
54a5f4d
fix lint errors
valekjo Apr 4, 2023
c7ca6c8
Update sources/platform/collaboration/organization_account/index.md
valekjo Apr 5, 2023
04caded
Update sources/platform/integrations/api.md
valekjo Apr 5, 2023
ffe067c
Update sources/platform/integrations/api.md
valekjo Apr 5, 2023
587e507
Update sources/platform/integrations/slack.md
valekjo Apr 5, 2023
1a24bea
Update sources/platform/integrations/slack.md
valekjo Apr 5, 2023
64281d4
Update sources/platform/integrations/slack.md
valekjo Apr 5, 2023
9579610
Update sources/platform/integrations/slack.md
valekjo Apr 5, 2023
6c014be
Update sources/platform/integrations/make.md
valekjo Apr 5, 2023
afb8207
Update sources/platform/integrations/api.md
valekjo Apr 5, 2023
26e0f6a
Update sources/platform/integrations/api.md
valekjo Apr 5, 2023
ece9622
Update sources/platform/integrations/api.md
valekjo Apr 5, 2023
1976a5d
Update sources/platform/integrations/api.md
valekjo Apr 5, 2023
d058112
Update sources/platform/integrations/index.mdx
valekjo Apr 5, 2023
1787e6e
Update sources/platform/integrations/drive.md
valekjo Apr 5, 2023
bf9ad99
Update sources/platform/integrations/drive.md
valekjo Apr 5, 2023
b0b1058
Update sources/platform/integrations/drive.md
valekjo Apr 5, 2023
3bca53d
Update sources/platform/integrations/github.md
valekjo Apr 5, 2023
ccce0a0
Update sources/platform/integrations/github.md
valekjo Apr 5, 2023
bcccdfd
Update sources/platform/integrations/github.md
valekjo Apr 5, 2023
b6e54fe
Update sources/platform/integrations/github.md
valekjo Apr 5, 2023
31529c5
Update sources/platform/integrations/gmail.md
valekjo Apr 5, 2023
45d911f
Update sources/platform/integrations/index.mdx
valekjo Apr 5, 2023
60ff157
Update sources/platform/integrations/gmail.md
valekjo Apr 5, 2023
d0a9b15
Update sources/platform/integrations/index.mdx
valekjo Apr 5, 2023
4d61208
Update sources/platform/integrations/index.mdx
valekjo Apr 5, 2023
9398b44
Update sources/platform/integrations/index.mdx
valekjo Apr 5, 2023
644fa8a
Update sources/platform/integrations/index.mdx
valekjo Apr 5, 2023
b709f4d
Update sources/platform/integrations/index.mdx
valekjo Apr 5, 2023
4ec3b3d
Update sources/platform/integrations/index.mdx
valekjo Apr 5, 2023
5115073
Update sources/platform/integrations/index.mdx
valekjo Apr 5, 2023
1371731
Update sources/platform/integrations/index.mdx
valekjo Apr 5, 2023
69fd734
Update sources/platform/integrations/index.mdx
valekjo Apr 5, 2023
eccef8c
Update sources/platform/integrations/langchain.md
valekjo Apr 5, 2023
2bb3485
Update sources/platform/integrations/langchain.md
valekjo Apr 5, 2023
f0eddac
Update sources/platform/integrations/langchain.md
valekjo Apr 5, 2023
9426f20
Update sources/platform/integrations/langchain.md
valekjo Apr 5, 2023
a850ad1
Update sources/platform/integrations/make.md
valekjo Apr 5, 2023
d664685
Update sources/platform/integrations/make.md
valekjo Apr 5, 2023
7902ebd
Update sources/platform/integrations/langchain.md
valekjo Apr 5, 2023
3148910
Update sources/platform/integrations/api.md
valekjo Apr 5, 2023
71cc51d
Space fix
valekjo Apr 5, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
16
2 changes: 1 addition & 1 deletion sources/platform/actors/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ slug: /actors

Actors are serverless cloud programs that can do almost anything a human can do in a web browser. They can do anything from small tasks like filling in forms or unsubscribing from online services all the way up to scraping and processing vast numbers of web pages.

You can use Actors [manually in Apify Console](https://console.apify.com/actors), by using the [API](/api/v2) or [scheduler](../schedules.md). You can easily [integrate them with other apps](../integrations/index.md) and share your Actors with other Apify users via [Apify Store](https://apify.com/store) or [access rights](./collaboration/access-rights) system.
You can use Actors [manually in Apify Console](https://console.apify.com/actors), by using the [API](/api/v2) or [scheduler](../schedules.md). You can easily [integrate them with other apps](../integrations/index.mdx) and share your Actors with other Apify users via [Apify Store](https://apify.com/store) or [access rights](./collaboration/access-rights) system.

> New to Apify? Try actors with our [quick start](../index.mdx) tutorial and see the [Apify Academy's courses](/academy).

Expand Down
4 changes: 2 additions & 2 deletions sources/platform/actors/publishing/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ There are four main stages of building a public actor:
3. [Testing and maintenance](../development/testing_and_maintenance.md).
4. [Promotion](../../academy/get-most-of-actors/seo-and-promotion).

While you don't necessarily have to maintain your private Actors, public Actors require a higher degree of responsibility.
While you don't necessarily have to maintain your private Actors, public Actors require a higher degree of responsibility.

As the name implies, Public Actors are available to the public on [Apify Store](https://apify.com/store), which means that an unmaintained public Actor could negatively affect all the other users that depend on it for their own activities on the platform.
As the name implies, Public Actors are available to the public on [Apify Store](https://apify.com/store), which means that an unmaintained public Actor could negatively affect all the other users that depend on it for their own activities on the platform.

Public Actors are regularly submitted to [automated tests](./testing.mdx) to ensure they are functioning properly. So, before making an Actor public, we recommend you reserve enough time to maintain the project (~2 hours weekly). This will ensure that your Actor maintains its long-term quality, improving your chances of successfully [monetizing your Actors](./monetize.mdx).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ The organization, its actors and integrations will keep running as they are. The

While you cannot manage an organization account's settings and members via API, you can access its actor and task runs, webhooks, schedules and storages just like you would with any other account.

As a member of an organization, you are assigned an [API token](../../integrations/index.md) (under the **Integrations** tab) and proxy password (click the **Proxy** button in the left menu) for accessing the Apify platform via REST API.
As a member of an organization, you are assigned an [API token](../../integrations/index.mdx) (under the **Integrations** tab) and proxy password (click the **Proxy** button in the left menu) for accessing the Apify platform via REST API.

![Integration tokens](../images/organizations/integrations.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ You can [switch](./how_to_use.md) between your personal and organization account
You can set up an organization in two ways.

* [Create a new organization](#create-a-new-organization). If you don't have integrations set up yet, or if they are easy to change, you can create a new organization, preserving your personal account.
* [Convert an existing account](#convert-an-existing-account) into an organization. If your actors and [integrations](../../integrations/index.md) are set up in a personal account, it is probably best to convert that account into an organization. This will preserve all your integrations but means you will have a new personal account created for you.
* [Convert an existing account](#convert-an-existing-account) into an organization. If your Actors and [integrations](../../integrations/index.mdx) are set up in a personal account, it is probably best to convert that account into an organization. This will preserve all your integrations but means you will have a new personal account created for you.

> Prefer video to reading? [See our video tutorial](https://www.youtube.com/watch?v=BIL6HqtnvKk) for organization accounts.

Expand Down
47 changes: 47 additions & 0 deletions sources/platform/integrations/api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
title: API
description: Learn how to integrate with Apify via API.
sidebar_position: 11.01
slug: /integrations/api
---

# API integrations

**Learn how to integrate with Apify via API.**

---

The API is well described in the [**API Reference**](/api/v2). If you want to use the Apify API from JavaScript/NodeJS or Python, we recommend you use one of our API clients:

- [**apify-client**](/api/client/js/) NPM package supporting both browser and server
- [**apify-client**](/api/client/python/) PyPI package.

You are not limited to those packages - any HTTP client can be used (axios, curl, wget, ...) - but the official API clients implement the best practices such as exponential backoff or rate limit handling.

## API token

To access the Apify API in your integrations, you need to authenticate using your secret API token. You can find it on the [Integrations](https://console.apify.com/account?tab=integrations) page in Apify Console. Give your token a reasonable description, and never use one token for several services, much like you shouldn't use the same password for different accounts.

![Integrations page in Apify Console](./images/api-token.png)

## Authentication

There are 2 ways how to authenticate the Apify API. You can either pass the token via the `Authorization` HTTP header or the URL `token` query parameter. We always recommend you use the authentication via the HTTP header as this method is more secure.

> **IMPORTANT**: **Do not share the API token with untrusted parties, or use it directly from client-side code,
unless you fully understand the consequences!**

Note that some API endpoints, such as [Get list of keys](/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys),
do not require an authentication token because they contain a hard-to-guess identifier that effectively serves as an authentication key.

## Organization accounts

> This information is only relevant to members or owners of organization accounts.

When working under an organization account, you will see two types of API tokens on the Integrations page.

![Integrations page in the Apify Console in organizatoin mode](./images/api-token-organization.png)

The Personal API tokens are different from your own Personal API tokens mentioned above. If you use this token in an integration, it will have the same permissions that you have within the organization, and all the operations you use it for will be ascribed to you.

On the other hand the Organization API tokens (only visible if you are the owner or have Manage access tokens permission) have full permissions and are not tied to a specific member of the organization.
21 changes: 21 additions & 0 deletions sources/platform/integrations/drive.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Google Drive
description: Learn how to integrate Apify with Google Drive
sidebar_position: 11.15
slug: /integrations/drive
---

# Google Drive integration

**Learn how to integrate your Apify Actors with Google Drive. This article shows you how to automatically save results to your drive when an Actor run succeeds.**

---

## Get started

To use the Apify integration for Google Drive, you will need:

- An [Apify account](https://console.apify.com/).
- A Google account

<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/IFTeKdj6ZGM" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
16 changes: 13 additions & 3 deletions sources/platform/integrations/github.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: GitHub
description: Learn how to integrate your Apify actors with GitHub. This article shows you how to automatically create an issue in your repo when an actor run fails.
sidebar_position: 11.2
description: Learn how to integrate your Apify Actors with GitHub. This article shows you how to automatically create an issue in your repo when an Actor run fails.
sidebar_position: 11.11
slug: /integrations/github
---

# GitHub integration

**Learn how to integrate your Apify actors with GitHub. This article shows you how to automatically create an issue in your repo when an actor run fails.**
**Learn how to integrate your Apify Actors with GitHub. This article shows you several possible integrations.**

---

Expand All @@ -18,4 +18,14 @@ To use the Apify integration for GitHub, you will need:
- An [Apify account](https://console.apify.com/).
- A GitHub repository.

### Create an Actor from a GitHub repository

<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/NEzT_p_RE1Q" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>

### Deploy changes automatically

<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/j2I3DM8Nvu1M" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>

### Create an issue when a run fails

<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/jZUp-rRbayc" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
21 changes: 21 additions & 0 deletions sources/platform/integrations/gmail.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Gmail
description: Learn how to integrate Apify with Gmail
sidebar_position: 11.14
slug: /integrations/gmail
---

# Gmail integration

**Learn how to integrate your Apify Actors with Gmail. This article shows you how to automatically send an email with results when an Actor run succeeds.**

---

## Get started

To use the Apify integration for Gmail, you will need:

- An [Apify account](https://console.apify.com/).
- A Google account

<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/BcFexrRxzdM" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
64 changes: 0 additions & 64 deletions sources/platform/integrations/index.md

This file was deleted.

160 changes: 160 additions & 0 deletions sources/platform/integrations/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,160 @@
---
title: Integrations
description: Learn how to integrate the Apify platform with other services, your systems, data pipelines, and other web automation workflows.
sidebar_position: 11
category: platform
slug: /integrations
---

import Card from "@site/src/components/Card";
import CardGrid from "@site/src/components/CardGrid";

# Integrations

**Learn how to integrate the Apify platform with other services, your systems, data pipelines, and other web automation workflows.**

> The whole is greater than the sum of its parts.
>
> 👴 *Aristotle*

Integrations allow you to combine separate applications and take advantage of their combined capabilities. Automation of these online processes increases your productivity. That’s why we made Apify in a way that allows you to connect it with practically any cloud service or web app and make it part of your larger projects.

## Built-in integrations

Apify‘s RESTful API allows you to interact with the platform programmatically. HTTP webhooks notify you and your services when important events happen. By using the API, you can start Actors, retrieve their results, or basically do anything you can do on a platform UI

<CardGrid>
<Card
title="API"
desc="Control the Apify platform programmatically from your code."
to="/platform/integrations/api"
smallImage
/>
<Card
title="Webhooks"
desc="Trigger external events when your Actor run fails or succeeds."
to="/platform/integrations/webhooks"
smallImage
/>
</CardGrid><br />

Apify offers easy-to-set-up solutions for common scenarios, like uploading your datasets to Google Drive when the run succeeds or creating an issue on GitHub when it fails.

<CardGrid>
<Card
title="Slack"
to="/platform/integrations/slack"
imageUrl="/img/platform/integrations/slack.svg"
smallImage
/>
<Card
title="Google Drive"
to="/platform/integrations/drive"
imageUrl="/img/platform/integrations/drive.svg"
smallImage
/>
<Card
title="Gmail"
to="/platform/integrations/gmail"
imageUrl="/img/platform/integrations/gmail.svg"
smallImage
/>
<Card
title="Github"
to="/platform/integrations/github"
imageUrl="/img/platform/integrations/github.svg"
smallImage
/>
<Card
title="Git"
to="/platform/actors/development/source-code#git-repository"
imageUrl="/img/platform/integrations/git.svg"
smallImage
/>
{/* Only show Asana once we have the videos ready for it
<Card
title="Asana"
to="/"
imageUrl="/img/platform/integrations/asana.svg"
smallImage
/>
*/}
{/* Only show Trello once it's enabled for all users on platform
<Card
title="Trello"
to="/"
imageUrl="/img/platform/integrations/trello.svg"
smallImage
/>
*/}
</CardGrid>

## Automation platforms

If you use one of the main automation platforms, Apify support is here for you. The main advantage of these platforms is that you can integrate Apify into very complex workflows with the choice of thousands of supported services.

<CardGrid>
<Card
title="Make"
to="./integrations/make"
imageUrl="/img/platform/integrations/make.svg"
smallImage
/>
<Card
title="Zapier"
to="https://help.apify.com/en/articles/3034235-getting-started-with-apify-integration-for-zapier"
imageUrl="/img/platform/integrations/zapier.svg"
smallImage
/>
<Card
title="Transposit"
to="https://www.transposit.com/docs/guides/apify/"
imageUrl="/img/platform/integrations/transposit.svg"
smallImage
/>
</CardGrid>


## Data pipelines, ETLs, and AI/LLM tools

The Apify platform integrates with popular ETL and data pipeline services, enabling you to integrate Apify Actors directly into your data integration processes.

<CardGrid>
<Card
title="Keboola"
to="https://help.apify.com/en/articles/2003234-keboola-integration"
imageUrl="/img/platform/integrations/keboola.svg"
smallImage
/>
<Card
title="Airbyte"
to="https://docs.airbyte.io/integrations/sources/apify-dataset"
imageUrl="/img/platform/integrations/airbyte.svg"
smallImage
/>
<Card
title="Hevo"
to="https://docs.hevodata.com/sources/engg-analytics/apify/"
imageUrl="/img/platform/integrations/hevo.svg"
smallImage
/>
</CardGrid><br />


If you are working on an AI/LLM-related project, we recommend you look into the Langchain integration.

<CardGrid>
<Card
title="Langchain"
to="./integrations/langchain"
imageUrl="/img/platform/integrations/langchain.png"
smallImage
/>
</CardGrid>

## Other Actors

Explore [Apify Store](https://apify.com/store) for Actors that may help you with integrations, for example, [MongoDB Import](https://apify.com/drobnikj/mongodb-import) or [MySQL Insert](https://apify.com/petr_cermak/mysql-insert).

![Apify Store](./images/apify-store.png)

Loading