From b6085b3313b817f6b8946d37c4e6b0f0ce90ab65 Mon Sep 17 00:00:00 2001 From: Marcel Rebro Date: Fri, 20 Nov 2026 14:30:37 +0100 Subject: [PATCH 1/3] docs: link to the Console create token form Token instructions now open the create token form in Apify Console directly, with the description prefilled per integration, instead of pointing to the docs page or the Settings page. Co-Authored-By: Claude Opus 5.5 --- .../components/securitySchemes/apiKey.yaml | 2 +- .../securitySchemes/httpBearer.yaml | 2 +- apify-api/openapi/openapi.yaml | 10 +++--- sources/_partials/_create-api-token.mdx | 4 ++- .../platform/getting_started/apify_client.md | 2 +- .../run_actor_and_retrieve_data_via_api.md | 4 +-- sources/api/getting-started.mdx | 2 +- sources/platform/actors/running/schedules.md | 2 +- .../integrations/agents/antigravity.md | 2 +- .../agents/claude/claude-code-cli.md | 2 +- .../platform/integrations/agents/cursor.md | 2 +- .../integrations/agents/deepseek-harness.md | 2 +- .../github-copilot/github-copilot-cli.md | 2 +- .../platform/integrations/agents/grok-bot.md | 2 +- .../integrations/agents/grok-build.md | 2 +- .../integrations/agents/hermes-agent.md | 2 +- .../integrations/agents/kimi-code-cli.md | 2 +- .../platform/integrations/agents/lovable.md | 2 +- sources/platform/integrations/agents/manus.md | 2 +- .../integrations/agents/openai/chatgpt.md | 2 +- .../integrations/agents/openai/codex-app.md | 2 +- .../integrations/agents/openai/codex-cli.md | 2 +- .../platform/integrations/agents/openclaw.md | 2 +- .../platform/integrations/agents/opencode.md | 2 +- .../integrations/agents/qoder/qwen.md | 2 +- sources/platform/integrations/ai/agno.md | 2 +- sources/platform/integrations/ai/crewai.md | 2 +- sources/platform/integrations/ai/flowise.md | 2 +- .../platform/integrations/ai/google-adk.md | 2 +- .../integrations/ai/langchain/langgraph.md | 2 +- sources/platform/integrations/ai/langflow.md | 2 +- sources/platform/integrations/ai/llama.md | 3 +- sources/platform/integrations/ai/mastra.md | 2 +- .../integrations/ai/openai/openai-agents.md | 2 +- sources/platform/integrations/ai/upsonic.md | 2 +- .../platform/integrations/ai/vercel-ai-sdk.md | 2 +- .../integrations/data-and-storage/airbyte.md | 2 +- .../integrations/data-and-storage/keboola.md | 2 +- .../platform/integrations/programming/api.md | 3 +- .../integrations/programming/github.md | 2 +- .../activepieces.md | 2 +- .../workflows-and-notifications/albato.md | 6 ++-- .../workflows-and-notifications/dify.md | 2 +- .../gumloop/index.md | 2 +- .../make/ai-crawling.md | 6 ++-- .../make/e-commerce.md | 6 ++-- .../workflows-and-notifications/make/index.md | 2 +- .../workflows-and-notifications/make/llm.md | 6 ++-- .../workflows-and-notifications/n8n/index.md | 2 +- .../n8n/website-content-crawler.md | 6 ++-- .../workflows-and-notifications/pipedream.md | 2 +- .../workflows-and-notifications/telegram.md | 2 +- .../workflows-and-notifications/viasocket.md | 2 +- .../workflows-and-notifications/workato.md | 2 +- src/components/ApiToken.jsx | 31 ++++++++++--------- 55 files changed, 87 insertions(+), 86 deletions(-) diff --git a/apify-api/openapi/components/securitySchemes/apiKey.yaml b/apify-api/openapi/components/securitySchemes/apiKey.yaml index 708edef8a0..3108b8c8ac 100644 --- a/apify-api/openapi/components/securitySchemes/apiKey.yaml +++ b/apify-api/openapi/components/securitySchemes/apiKey.yaml @@ -4,7 +4,7 @@ in: query description: |- API token provided as a query parameter (e.g., `?token=your_token`—less secure). - Use your API token to authenticate requests. You can create one on the [Integrations page](https://console.apify.com/settings/integrations) in Apify Console. The Console shows the token only once, right after you create or rotate it, so copy it and store it somewhere safe. + Use your API token to authenticate requests. [Create one in Apify Console](https://console.apify.com/settings/integrations?createApiToken=true). The Console shows the token only once, right after you create or rotate it, so copy it and store it somewhere safe. :::danger Security diff --git a/apify-api/openapi/components/securitySchemes/httpBearer.yaml b/apify-api/openapi/components/securitySchemes/httpBearer.yaml index 9a9f82678c..d44ca16546 100644 --- a/apify-api/openapi/components/securitySchemes/httpBearer.yaml +++ b/apify-api/openapi/components/securitySchemes/httpBearer.yaml @@ -3,7 +3,7 @@ scheme: bearer description: |- Bearer token provided in the `Authorization` header (e.g., `Authorization: Bearer your_token`—recommended). For details, see the [`Authorization` header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization) on MDN. - Use your API token to authenticate requests. You can create one on the [Integrations page](https://console.apify.com/settings/integrations) in Apify Console. The Console shows the token only once, right after you create or rotate it, so copy it and store it somewhere safe. This method is more secure than query parameters, as headers are not logged in browser history or server logs. + Use your API token to authenticate requests. [Create one in Apify Console](https://console.apify.com/settings/integrations?createApiToken=true). The Console shows the token only once, right after you create or rotate it, so copy it and store it somewhere safe. This method is more secure than query parameters, as headers are not logged in browser history or server logs. :::danger Security diff --git a/apify-api/openapi/openapi.yaml b/apify-api/openapi/openapi.yaml index 649b0d9640..bd96c76e8e 100644 --- a/apify-api/openapi/openapi.yaml +++ b/apify-api/openapi/openapi.yaml @@ -47,9 +47,9 @@ info: ## Authentication - **You can create an API token on the - [Integrations](https://console.apify.com/settings/integrations) page in the - Apify Console.** The Console shows the token only once, right after you create + **You can [create an API token in Apify + Console](https://console.apify.com/settings/integrations?createApiToken=true).** + The Console shows the token only once, right after you create or rotate it, so copy it and store it somewhere safe. For details, see [API token](https://docs.apify.com/integrations/api#api-token). @@ -99,7 +99,7 @@ info: If the Actor is not runnable anonymously, you will receive a 401 or 403 [response code](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status). This means you need to add your [secret API - token](https://console.apify.com/account#/integrations) to the request's + token](https://docs.apify.com/integrations/api#api-token) to the request's `Authorization` header ([recommended](#/introduction/authentication)) or as a URL query parameter `?token=[your_token]` (less secure). @@ -110,7 +110,7 @@ info: `Apify.call()` method from the [Apify SDK](https://sdk.apify.com/docs/api/apify#apifycallactid-input-options). It runs the Actor using the account you are currently logged into (determined - by the [secret API token](https://console.apify.com/account#/integrations)). + by the [secret API token](https://docs.apify.com/integrations/api#api-token)). The result is an [Actor run object](https://sdk.apify.com/docs/typedefs/actor-run) and its output (if any). diff --git a/sources/_partials/_create-api-token.mdx b/sources/_partials/_create-api-token.mdx index f3a937971b..3006864ccf 100644 --- a/sources/_partials/_create-api-token.mdx +++ b/sources/_partials/_create-api-token.mdx @@ -1 +1,3 @@ -To get an API token, go to [**Settings > API & Integrations**](https://console.apify.com/settings/integrations) in Apify Console, select **Create a new token**, enter a description, select **Create**, and copy the token. You can view it only once, so store it somewhere safe, such as a password manager. If you lose it, [rotate the token](/integrations/api#rotation) or create a new one. +import { CreateTokenLink } from '@site/src/components/ApiToken'; + +To get an API token, create one in Apify Console and copy it. You can view it only once, so store it somewhere safe, such as a password manager. If you lose it, [rotate the token](/integrations/api#rotation) or create a new one. diff --git a/sources/academy/platform/getting_started/apify_client.md b/sources/academy/platform/getting_started/apify_client.md index 5fae8be32c..ca123c34c5 100644 --- a/sources/academy/platform/getting_started/apify_client.md +++ b/sources/academy/platform/getting_started/apify_client.md @@ -62,7 +62,7 @@ from apify_client import ApifyClient In the last lesson, we ran the **adding-actor** and retrieved its dataset items. That's exactly what we're going to do now; however, by using the Apify client instead. -Before we can use the client, we must create a new instance of the `ApifyClient` class and pass it our API token. If you don't have a token stored, [create one](/integrations/api#create-api-token) on the [**API & Integrations** page](https://console.apify.com/settings/integrations?asrc=developers_portal) in Apify Console and copy it. +Before we can use the client, we must create a new instance of the `ApifyClient` class and pass it our API token. If you don't have a token stored, [create one in Apify Console](https://console.apify.com/settings/integrations?createApiToken=true&asrc=developers_portal) and copy it. diff --git a/sources/academy/tutorials/api/run_actor_and_retrieve_data_via_api.md b/sources/academy/tutorials/api/run_actor_and_retrieve_data_via_api.md index 359b17d418..82a5a89df8 100644 --- a/sources/academy/tutorials/api/run_actor_and_retrieve_data_via_api.md +++ b/sources/academy/tutorials/api/run_actor_and_retrieve_data_via_api.md @@ -33,7 +33,7 @@ To run, or **call**, an Actor/task, you will need a few things: - The name or ID of the Actor/task. The name looks like `username~actorName` or `username~taskName`. The ID can be retrieved on the **Settings** page of the Actor/task. -- Your [API token](/integrations/api#create-api-token), which you can create on the **API & Integrations** page in [Apify Console](https://console.apify.com/settings/integrations). Apify Console shows the token only once, so copy it right away. Don't share it with anyone. +- Your [API token](/integrations/api#create-api-token), which you can [create in Apify Console](https://console.apify.com/settings/integrations?createApiToken=true). Apify Console shows the token only once, so copy it right away. Don't share it with anyone. - Possibly an input, which is passed in JSON format as the request's **body**. @@ -158,7 +158,7 @@ Here is a Node.js example of calling a task via the API and logging the dataset import got from 'got'; // Specify your API token -// (create one at https://console.apify.com/settings/integrations) +// (create one at https://console.apify.com/settings/integrations?createApiToken=true) const myToken = 'YOUR_API_TOKEN'; // Start apify/google-search-scraper Actor diff --git a/sources/api/getting-started.mdx b/sources/api/getting-started.mdx index 59e8826df4..951470875e 100644 --- a/sources/api/getting-started.mdx +++ b/sources/api/getting-started.mdx @@ -29,7 +29,7 @@ The diagram illustrates the basic workflow when using the Apify API: Before you can start using the API, check if you have all the necessary prerequisites: -* An Apify account with an API token. Most requests need to be authenticated with the Apify API token passed via the `Authorization` HTTP header. For details, see [Authentication](/api/v2#authentication). +* An Apify account with an API token ([create one in Apify Console](https://console.apify.com/settings/integrations?createApiToken=true)). Most requests need to be authenticated with the Apify API token passed via the `Authorization` HTTP header. For details, see [Authentication](/api/v2#authentication). * A tool to make HTTP requests (cURL, Postman, or your preferred programming language). ### Verify your access diff --git a/sources/platform/actors/running/schedules.md b/sources/platform/actors/running/schedules.md index fbda03e4cd..84ce9c9790 100644 --- a/sources/platform/actors/running/schedules.md +++ b/sources/platform/actors/running/schedules.md @@ -80,7 +80,7 @@ To authenticate, use a secret API token. When providing your API authentication token, we recommend using the request's `Authorization` header, rather than the URL. For details, see [Authentication](/api/v2#authentication). ::: -In the `POST` request's payload should be a JSON object specifying the schedule's name, your [user ID](https://console.apify.com/settings/integrations), and the schedule's _actions_. +In the `POST` request's payload should be a JSON object specifying the schedule's name, your user ID (on the [**API & Integrations**](https://console.apify.com/settings/integrations) page of your account settings), and the schedule's _actions_. The following JSON object creates a schedule which runs an SEO audit of the Apify domain once a month. diff --git a/sources/platform/integrations/agents/antigravity.md b/sources/platform/integrations/agents/antigravity.md index 6a9ee68dae..2a807d2868 100644 --- a/sources/platform/integrations/agents/antigravity.md +++ b/sources/platform/integrations/agents/antigravity.md @@ -110,7 +110,7 @@ With the default permission preset, Antigravity runs agent commands in a [termin The MCP sign-in doesn't need a browser on the machine that runs Antigravity. Over SSH or in a container, open the sign-in link that Antigravity shows in a browser on any machine, then paste the authorization code back at the `agy` prompt. -If you can't use OAuth at all, use the skills that don't need the MCP server and authenticate them with a token. Set it before starting Antigravity: +If you can't use OAuth at all, use the skills that don't need the MCP server and authenticate them with a token. Set it before starting Antigravity: ```bash export APIFY_TOKEN= diff --git a/sources/platform/integrations/agents/claude/claude-code-cli.md b/sources/platform/integrations/agents/claude/claude-code-cli.md index 06225c0e68..dc0fbfcfc5 100644 --- a/sources/platform/integrations/agents/claude/claude-code-cli.md +++ b/sources/platform/integrations/agents/claude/claude-code-cli.md @@ -145,7 +145,7 @@ Plugins require a local installation of the Claude Code CLI. They aren't availab If the browser doesn't open automatically, copy the OAuth URL shown in the terminal and paste it into your browser manually. -If you're running Claude Code in a headless environment (SSH, remote container) or the OAuth flow still fails, use token authentication instead. Set it before starting Claude Code: +If you're running Claude Code in a headless environment (SSH, remote container) or the OAuth flow still fails, use token authentication instead. Set it before starting Claude Code: ```bash export APIFY_TOKEN= diff --git a/sources/platform/integrations/agents/cursor.md b/sources/platform/integrations/agents/cursor.md index 730cd9ba5d..e0af9b8fbd 100644 --- a/sources/platform/integrations/agents/cursor.md +++ b/sources/platform/integrations/agents/cursor.md @@ -106,7 +106,7 @@ Start your request with `@apify` so the routing agent handles it. The agent owns If the browser doesn't open automatically, copy the OAuth URL shown by Cursor and paste it into your browser manually. -If you're running Cursor in a remote session, devcontainer, or over SSH where no browser is available, use token authentication instead. Set it in your environment before starting Cursor: +If you're running Cursor in a remote session, devcontainer, or over SSH where no browser is available, use token authentication instead. Set it in your environment before starting Cursor: ```bash export APIFY_TOKEN= diff --git a/sources/platform/integrations/agents/deepseek-harness.md b/sources/platform/integrations/agents/deepseek-harness.md index ebd43d710f..d7dc3099bf 100644 --- a/sources/platform/integrations/agents/deepseek-harness.md +++ b/sources/platform/integrations/agents/deepseek-harness.md @@ -70,7 +70,7 @@ The plugin enables the Apify MCP server on install. Searching Apify Store, inspe `dsh` sends static MCP headers and has no OAuth flow, so authenticate with an API token: -1. +1. 1. Create a `.env` file in the directory you launch `dsh` from: diff --git a/sources/platform/integrations/agents/github-copilot/github-copilot-cli.md b/sources/platform/integrations/agents/github-copilot/github-copilot-cli.md index 2c3007f717..ea96fd4cd4 100644 --- a/sources/platform/integrations/agents/github-copilot/github-copilot-cli.md +++ b/sources/platform/integrations/agents/github-copilot/github-copilot-cli.md @@ -113,7 +113,7 @@ On the first start, Copilot may report that `apify-mcp-server` is taking longer If the browser doesn't open automatically, copy the OAuth URL shown in the terminal and paste it into your browser manually. -If you're running the CLI in a headless environment (SSH, remote container) or the OAuth flow still fails, use token authentication instead. Set it before starting the CLI: +If you're running the CLI in a headless environment (SSH, remote container) or the OAuth flow still fails, use token authentication instead. Set it before starting the CLI: ```bash export APIFY_TOKEN= diff --git a/sources/platform/integrations/agents/grok-bot.md b/sources/platform/integrations/agents/grok-bot.md index f6abe08cf9..2764ddf8c6 100644 --- a/sources/platform/integrations/agents/grok-bot.md +++ b/sources/platform/integrations/agents/grok-bot.md @@ -106,7 +106,7 @@ Open **Settings** > **Plugins**, find the **Apify** connector, and complete auth If the browser doesn't open automatically, copy the OAuth URL shown by Grok Bot and paste it into your browser manually. -If the OAuth flow still fails, use token authentication instead. Set it on the Grok Bot computer: +If the OAuth flow still fails, use token authentication instead. Set it on the Grok Bot computer: ```bash export APIFY_TOKEN= diff --git a/sources/platform/integrations/agents/grok-build.md b/sources/platform/integrations/agents/grok-build.md index f0f33986bb..2e61caed89 100644 --- a/sources/platform/integrations/agents/grok-build.md +++ b/sources/platform/integrations/agents/grok-build.md @@ -99,7 +99,7 @@ If the OAuth flow still can't complete, for example because no browser is availa apify login ``` -In a non-interactive environment, use token authentication instead. Then pass it to `apify login`: +In a non-interactive environment, use token authentication instead. Then pass it to `apify login`: ```bash apify login -t diff --git a/sources/platform/integrations/agents/hermes-agent.md b/sources/platform/integrations/agents/hermes-agent.md index bef7ce7621..03ba1fd3a0 100644 --- a/sources/platform/integrations/agents/hermes-agent.md +++ b/sources/platform/integrations/agents/hermes-agent.md @@ -20,7 +20,7 @@ For more details about Hermes Agent, refer to the [official documentation](https Before integrating Apify with Hermes Agent, you'll need: - _An Apify account_ - If you don't have one, [sign up here](https://console.apify.com/sign-up). -- _Apify API token_ - +- _Apify API token_ - - _Hermes Agent_ - Version 0.18.1 or later. Install the CLI from the [official documentation](https://hermes-agent.nousresearch.com/docs). - _Python 3.11 to 3.13_ - Required to install the plugin. diff --git a/sources/platform/integrations/agents/kimi-code-cli.md b/sources/platform/integrations/agents/kimi-code-cli.md index 597b210534..136f4ed602 100644 --- a/sources/platform/integrations/agents/kimi-code-cli.md +++ b/sources/platform/integrations/agents/kimi-code-cli.md @@ -149,7 +149,7 @@ Run `/mcp-config login apify` explicitly rather than waiting for an automatic pr If you're running Kimi Code in a headless environment (SSH, remote container) or in non-interactive prompt mode (`kimi -p`), the OAuth handshake can't complete. Authenticate on a machine with a browser first, then point the headless machine at the same `KIMI_CODE_HOME` so it picks up `credentials/mcp/`. Alternatively, override the `apify` entry in `~/.kimi-code/mcp.json` or `.kimi-code/mcp.json` with a static token - a project-level entry with the same name overrides the plugin's declaration. -For the CLI and SDK skills, use token authentication. Export it before starting Kimi Code: +For the CLI and SDK skills, use token authentication. Export it before starting Kimi Code: ```bash export APIFY_TOKEN= diff --git a/sources/platform/integrations/agents/lovable.md b/sources/platform/integrations/agents/lovable.md index eb882cd7cd..d085167090 100644 --- a/sources/platform/integrations/agents/lovable.md +++ b/sources/platform/integrations/agents/lovable.md @@ -24,7 +24,7 @@ Apify is available as an app and chat connector: one connection works both in th Before you connect the two platforms, you need: - _An Apify account_ - If you don't have one, [sign up here](https://console.apify.com/sign-up). -- _Apify API token_ - See [API token](/integrations/api#api-token) for scope and expiration options. +- _Apify API token_ - See [API token](/integrations/api#api-token) for scope and expiration options. - _A Lovable account_ - App and chat connectors are available on the Free, Pro, and Business plans. - _Permission to create connections_ - Enterprise plans restrict connection creation to **No one** by default, until an admin changes it in **Connectors > Admin settings > App + chat connectors**. diff --git a/sources/platform/integrations/agents/manus.md b/sources/platform/integrations/agents/manus.md index 1e80163457..92ec75b5d5 100644 --- a/sources/platform/integrations/agents/manus.md +++ b/sources/platform/integrations/agents/manus.md @@ -173,7 +173,7 @@ Manus will load the skill instructions and use the appropriate Apify Actors to c If the OAuth prompt fails or you can't complete the login flow, you can connect using your Apify API token directly. -1. +1. 1. In Manus, open the Apify connector settings and add a custom header: - **Header name** - `Authorization` - **Header value** - `Bearer ` (replace `` with your actual token) diff --git a/sources/platform/integrations/agents/openai/chatgpt.md b/sources/platform/integrations/agents/openai/chatgpt.md index fea53d432b..68e0e0dc32 100644 --- a/sources/platform/integrations/agents/openai/chatgpt.md +++ b/sources/platform/integrations/agents/openai/chatgpt.md @@ -25,7 +25,7 @@ In this tutorial, you'll learn how to connect _ChatGPT_ to the _Apify MCP server Before connecting ChatGPT to Apify, you'll need: - _An Apify account_ - If you don't have an Apify account already, you can [sign up](https://console.apify.com/sign-up) -- _Apify API token_ - This token authorizes the MCP server to run Actors on your behalf. +- _Apify API token_ - This token authorizes the MCP server to run Actors on your behalf. - _An OpenAI account with access to ChatGPT_ - You need an OpenAI account to use ChatGPT. - _ChatGPT with Developer mode enabled_ - You must enable [Developer Mode](https://platform.openai.com/docs/guides/developer-mode) to add custom connectors (when the Developer mode is active, the message input box is outlined in orange). diff --git a/sources/platform/integrations/agents/openai/codex-app.md b/sources/platform/integrations/agents/openai/codex-app.md index bdb7c6183a..48189d805e 100644 --- a/sources/platform/integrations/agents/openai/codex-app.md +++ b/sources/platform/integrations/agents/openai/codex-app.md @@ -107,7 +107,7 @@ Plugins require a local installation of Codex with plugin support enabled. Insta If the browser doesn't open automatically, copy the OAuth URL shown by Codex and paste it into your browser manually. -If you're running Codex in a headless environment (SSH, remote container) or the OAuth flow still fails, use token authentication instead. Set it before starting Codex: +If you're running Codex in a headless environment (SSH, remote container) or the OAuth flow still fails, use token authentication instead. Set it before starting Codex: ```bash export APIFY_TOKEN= diff --git a/sources/platform/integrations/agents/openai/codex-cli.md b/sources/platform/integrations/agents/openai/codex-cli.md index 3b1febfdf3..464f214379 100644 --- a/sources/platform/integrations/agents/openai/codex-cli.md +++ b/sources/platform/integrations/agents/openai/codex-cli.md @@ -105,7 +105,7 @@ Reopen `/plugins`, move to the **Apify Plugin** tab, and confirm the marketplace If the browser doesn't open automatically, copy the OAuth URL shown in the terminal and paste it into your browser manually. -If you're running the Codex CLI in a headless environment (SSH, remote container) or the OAuth flow still fails, use token authentication instead. Set it before starting Codex: +If you're running the Codex CLI in a headless environment (SSH, remote container) or the OAuth flow still fails, use token authentication instead. Set it before starting Codex: ```bash export APIFY_TOKEN= diff --git a/sources/platform/integrations/agents/openclaw.md b/sources/platform/integrations/agents/openclaw.md index 7b1a682d01..6832b2579e 100644 --- a/sources/platform/integrations/agents/openclaw.md +++ b/sources/platform/integrations/agents/openclaw.md @@ -34,7 +34,7 @@ Watch a quick demo of the Apify plugin for OpenClaw: Before integrating Apify with OpenClaw, you'll need: - _An Apify account_ - If you don't have one, [sign up here](https://console.apify.com/sign-up). -- _Apify API token_ - +- _Apify API token_ - - _OpenClaw_ - Version 2026.1.0 or later. Install from the [OpenClaw website](https://openclaw.io/). - _Node.js 22+_ - Required to run the plugin. Install from [nodejs.org](https://nodejs.org/en/download/). diff --git a/sources/platform/integrations/agents/opencode.md b/sources/platform/integrations/agents/opencode.md index 800abed2b4..84b2e0f049 100644 --- a/sources/platform/integrations/agents/opencode.md +++ b/sources/platform/integrations/agents/opencode.md @@ -97,7 +97,7 @@ Check that `opencode-apify` is listed under `plugin`. If it's missing, add it to If the browser doesn't open automatically, copy the OAuth URL shown in the terminal and paste it into your browser manually. -If you're running OpenCode in a headless environment (SSH, remote container) or the OAuth flow still fails, use token authentication instead. Set it before starting OpenCode: +If you're running OpenCode in a headless environment (SSH, remote container) or the OAuth flow still fails, use token authentication instead. Set it before starting OpenCode: ```bash export APIFY_TOKEN= diff --git a/sources/platform/integrations/agents/qoder/qwen.md b/sources/platform/integrations/agents/qoder/qwen.md index c9148a5ca4..6140605271 100644 --- a/sources/platform/integrations/agents/qoder/qwen.md +++ b/sources/platform/integrations/agents/qoder/qwen.md @@ -185,7 +185,7 @@ If the sign-in page doesn't open or the server stays disconnected: - **Qwen Code:** copy the authorization URL from the terminal and open it manually. If sign-in still fails, add an `Authorization: Bearer ` header to the `apify` server in `~/.qwen/settings.json` under `mcpServers` - see the [Streamable HTTP configuration](/mcp#streamable-http-with-oauth-recommended) for the shape. - **QwenWork:** remove the connector and add it again. If OAuth still won't complete, re-add it with an `Authorization` header set to `Bearer `. -For the `Authorization` header, use an API token. Setting `APIFY_TOKEN` in your shell doesn't authenticate the MCP server; it only covers the Apify CLI and `apify-client` used by the Actor development, actorization, and SDK integration skills, so run `apify login` once for those. +For the `Authorization` header, use an API token. Setting `APIFY_TOKEN` in your shell doesn't authenticate the MCP server; it only covers the Apify CLI and `apify-client` used by the Actor development, actorization, and SDK integration skills, so run `apify login` once for those. ## Limitations diff --git a/sources/platform/integrations/ai/agno.md b/sources/platform/integrations/ai/agno.md index ce3da5ce14..9c4db6661f 100644 --- a/sources/platform/integrations/ai/agno.md +++ b/sources/platform/integrations/ai/agno.md @@ -18,7 +18,7 @@ This guide shows how to integrate Apify Actors with Agno to empower your AI agen ### Prerequisites -- _Apify API token_: +- _Apify API token_: - _OpenAI API key_: Get your API key from the [OpenAI platform](https://platform.openai.com/account/api-keys). :::tip Alternative LLM providers diff --git a/sources/platform/integrations/ai/crewai.md b/sources/platform/integrations/ai/crewai.md index a344ab9a15..fbdda706de 100644 --- a/sources/platform/integrations/ai/crewai.md +++ b/sources/platform/integrations/ai/crewai.md @@ -18,7 +18,7 @@ This guide demonstrates how to integrate Apify Actors with CrewAI by building a ### Prerequisites -- **Apify API token**: +- **Apify API token**: - **OpenAI API key**: To power the agents in CrewAI, you need an OpenAI API key. Get one from the [OpenAI platform](https://platform.openai.com/account/api-keys). - **Python packages**: Install the following Python packages: diff --git a/sources/platform/integrations/ai/flowise.md b/sources/platform/integrations/ai/flowise.md index 8eda72e6c7..7bbe5ecff0 100644 --- a/sources/platform/integrations/ai/flowise.md +++ b/sources/platform/integrations/ai/flowise.md @@ -56,7 +56,7 @@ Now you need to configure the crawler. You can find more information about at [W In the configuration, provide your Apify API token. - + ![Apify API token screen](../images/flowise-apify-api.png) diff --git a/sources/platform/integrations/ai/google-adk.md b/sources/platform/integrations/ai/google-adk.md index 188ba2cf25..cb76aa3353 100644 --- a/sources/platform/integrations/ai/google-adk.md +++ b/sources/platform/integrations/ai/google-adk.md @@ -18,7 +18,7 @@ Apify is a marketplace of web scraping and automation tools, AI agents, and MCP ### Prerequisites -- _Apify API token_: +- _Apify API token_: - _Python packages_: Install the following Python packages: ```bash diff --git a/sources/platform/integrations/ai/langchain/langgraph.md b/sources/platform/integrations/ai/langchain/langgraph.md index bab1a5357d..f02c9d58e5 100644 --- a/sources/platform/integrations/ai/langchain/langgraph.md +++ b/sources/platform/integrations/ai/langchain/langgraph.md @@ -49,7 +49,7 @@ This guide shows how to use Apify Actors with LangGraph by building a ReAct agen ### Prerequisites -- **Apify API token**: +- **Apify API token**: - **OpenAI API key**: To work with agents in LangGraph, you need an OpenAI API key. If you don't have one, you can get it from the [OpenAI platform](https://platform.openai.com/account/api-keys). diff --git a/sources/platform/integrations/ai/langflow.md b/sources/platform/integrations/ai/langflow.md index 0ebfdbcd5c..7c32ddac62 100644 --- a/sources/platform/integrations/ai/langflow.md +++ b/sources/platform/integrations/ai/langflow.md @@ -21,7 +21,7 @@ This guide will demonstrate two different ways to use Apify Actors with Langflow ### Prerequisites -- **Apify API token**: +- **Apify API token**: - **OpenAI API key**: To work with agents in Langflow, you need an OpenAI API key. If you don't have one, you can get it from the [OpenAI platform](https://platform.openai.com/account/api-keys). diff --git a/sources/platform/integrations/ai/llama.md b/sources/platform/integrations/ai/llama.md index f0c4a1a0e7..f55ae8fa2b 100644 --- a/sources/platform/integrations/ai/llama.md +++ b/sources/platform/integrations/ai/llama.md @@ -6,6 +6,7 @@ slug: /integrations/llama-index --- import ThirdPartyDisclaimer from '@site/sources/_partials/_third-party-integration.mdx'; +import { GetApiTokenHint } from '@site/src/components/ApiToken'; > For more information on LlamaIndex, visit its [documentation](https://developers.llamaindex.ai/python/framework/). @@ -27,7 +28,7 @@ After successfully installing all dependencies, we can start writing Python code ### Apify Actor -To use the Apify Actor, import `ApifyActor` and `Document`, and set your [Apify API token](https://docs.apify.com/integrations/api#api-token) in the code. +To use the Apify Actor, import `ApifyActor` and `Document`, and set your [Apify API token](https://docs.apify.com/integrations/api#api-token) in the code. The following example uses the [Website Content Crawler](https://apify.com/apify/website-content-crawler) Actor to crawl an entire website, which will extract text content from the web pages. The extracted text is formatted as a llama_index `Document` and can be fed to a vector store or language model like GPT. diff --git a/sources/platform/integrations/ai/mastra.md b/sources/platform/integrations/ai/mastra.md index 1640bd9da0..82c56ae1dc 100644 --- a/sources/platform/integrations/ai/mastra.md +++ b/sources/platform/integrations/ai/mastra.md @@ -22,7 +22,7 @@ This guide demonstrates how to integrate Apify Actors with Mastra by building an ### Prerequisites -- _Apify API token_: +- _Apify API token_: - _LLM provider API key_: To power the agents, you need an LLM provider API key. For example, get one from the [OpenAI](https://platform.openai.com/account/api-keys) or [Anthropic](https://platform.claude.com/settings/keys). - _Node.js_: Ensure you have Node.js installed. - _Packages_: Install the following packages: diff --git a/sources/platform/integrations/ai/openai/openai-agents.md b/sources/platform/integrations/ai/openai/openai-agents.md index 4846a4280c..95c513e225 100644 --- a/sources/platform/integrations/ai/openai/openai-agents.md +++ b/sources/platform/integrations/ai/openai/openai-agents.md @@ -20,7 +20,7 @@ For more details about the OpenAI Agents SDK, refer to the [official documentati Before integrating Apify with OpenAI Agents SDK, you'll need: - _An Apify account_ - If you don't have an Apify account already, you can [sign up](https://console.apify.com/sign-up) -- _Apify API token_ - This token authorizes the Apify MCP server to run Actors on your behalf. +- _Apify API token_ - This token authorizes the Apify MCP server to run Actors on your behalf. - _OpenAI API key_ - Get your API key from the [OpenAI platform](https://platform.openai.com/account/api-keys). You need this to use OpenAI Agents SDK. - _Python packages_ - Install the required packages: diff --git a/sources/platform/integrations/ai/upsonic.md b/sources/platform/integrations/ai/upsonic.md index ce5377c5dc..813f3d2418 100644 --- a/sources/platform/integrations/ai/upsonic.md +++ b/sources/platform/integrations/ai/upsonic.md @@ -29,7 +29,7 @@ This guide shows how to integrate Apify Actors with Upsonic using the built-in ` ### Prerequisites -- Apify API token: +- Apify API token: - Anthropic API key (or another LLM provider): Get one from the [Anthropic Console](https://console.anthropic.com). - Python environment: Python 3.9 or later. - Required packages: Install the following dependencies: diff --git a/sources/platform/integrations/ai/vercel-ai-sdk.md b/sources/platform/integrations/ai/vercel-ai-sdk.md index ad8ea66151..004bd35fb7 100644 --- a/sources/platform/integrations/ai/vercel-ai-sdk.md +++ b/sources/platform/integrations/ai/vercel-ai-sdk.md @@ -18,7 +18,7 @@ Apify is a marketplace of ready-to-use web scraping and automation tools, AI age ### Prerequisites -- _Apify API token_: Set it as the `APIFY_TOKEN` environment variable. +- _Apify API token_: Set it as the `APIFY_TOKEN` environment variable. - _Node.js packages_: Install the following Node.js packages: ```bash diff --git a/sources/platform/integrations/data-and-storage/airbyte.md b/sources/platform/integrations/data-and-storage/airbyte.md index 893e8a61a1..8940030c6f 100644 --- a/sources/platform/integrations/data-and-storage/airbyte.md +++ b/sources/platform/integrations/data-and-storage/airbyte.md @@ -24,7 +24,7 @@ This guide shows you how to set up an Apify dataset as a source in Airbyte and c The Apify Dataset source reads items from a single dataset, identified by its ID. Each Actor run writes to a new default dataset. To keep syncing the results of repeated runs, have your Actor write to a [named dataset](/storage#named-and-unnamed-storages) and use its ID. 1. In [Apify Console](https://console.apify.com), open **Storage > Datasets**, select your dataset, and copy its ID. -1. +1. 1. In Airbyte, open the **Sources** tab and select **Apify Dataset**. 1. Enter the **Dataset ID** and **API token** you copied, and save the source. diff --git a/sources/platform/integrations/data-and-storage/keboola.md b/sources/platform/integrations/data-and-storage/keboola.md index 70aabcd291..8a6a817c8f 100644 --- a/sources/platform/integrations/data-and-storage/keboola.md +++ b/sources/platform/integrations/data-and-storage/keboola.md @@ -57,7 +57,7 @@ In the next step, you can choose the action you want to perform: After selecting the action, you will need to provide your Apify API token in the provided form. - + ![Keboola API authentication](../images/keboola/keboola-setup-api-token.png) diff --git a/sources/platform/integrations/programming/api.md b/sources/platform/integrations/programming/api.md index ab4ded0289..34c2db007e 100644 --- a/sources/platform/integrations/programming/api.md +++ b/sources/platform/integrations/programming/api.md @@ -28,8 +28,7 @@ unless you fully understand the consequences! You can also consider [limiting t ### Create an API token {#create-api-token} -1. Go to [**Settings > API & Integrations**](https://console.apify.com/settings/integrations) in Apify Console. -1. In the **Personal API tokens** section, select **Create a new token**. +1. Open the [create token form](https://console.apify.com/settings/integrations?createApiToken=true) in Apify Console. Alternatively, go to **Settings > API & Integrations** and select **Create a new token** in the **Personal API tokens** section. 1. Enter a description. Optionally, [limit the token's permissions](#limited-permissions) or [set an expiration date](#expiration). 1. Select **Create**. 1. Copy the token and store it somewhere safe, such as a password manager. diff --git a/sources/platform/integrations/programming/github.md b/sources/platform/integrations/programming/github.md index 8e8378d217..34459bd525 100644 --- a/sources/platform/integrations/programming/github.md +++ b/sources/platform/integrations/programming/github.md @@ -81,7 +81,7 @@ In such situation, to build your Actor automatically on every push, manually add https://api.apify.com/v2/actors/YOUR-ACTOR-NAME/builds?token=&version=0.0&tag=latest&waitForFinish=60 ``` -1. Replace the `` placeholder in the URL with an API token. +1. Replace the `` placeholder in the URL with an API token. 1. In your GitHub repository, go to **Settings > Webhooks > Add webhook**. 1. Paste the endpoint URL into **Payload URL** and set **Content type** to `application/json`. 1. Save your changes. diff --git a/sources/platform/integrations/workflows-and-notifications/activepieces.md b/sources/platform/integrations/workflows-and-notifications/activepieces.md index 9689259877..a3293d0910 100644 --- a/sources/platform/integrations/workflows-and-notifications/activepieces.md +++ b/sources/platform/integrations/workflows-and-notifications/activepieces.md @@ -41,7 +41,7 @@ To connect your Apify account to Activepieces: 1. In Activepieces, open the **Connections** section. 1. Click **+ New Connection**. 1. Search for and select the Apify piece. -1. Enter your Apify API token in the **API Key** field. +1. Enter your Apify API token in the **API Key** field. 1. Save the connection. ![Apify API key setup](../images/activepieces/api-token.png) diff --git a/sources/platform/integrations/workflows-and-notifications/albato.md b/sources/platform/integrations/workflows-and-notifications/albato.md index 656685f6ac..f28f2d5120 100644 --- a/sources/platform/integrations/workflows-and-notifications/albato.md +++ b/sources/platform/integrations/workflows-and-notifications/albato.md @@ -7,7 +7,7 @@ slug: /integrations/albato --- import ThirdPartyDisclaimer from '@site/sources/_partials/_third-party-integration.mdx'; -import { CreateTokenStep, CopyTokenStep } from '@site/src/components/ApiToken'; +import { CreateApiTokenLink, CopyTokenStep } from '@site/src/components/ApiToken'; [Albato](https://albato.com/automate) is a no-code integration platform that connects over 1,000 apps through a visual automation builder. With [Apify integration for Albato](https://albato.com/apps/apify), you can use Apify Actors as triggers or actions inside your Albato workflows to scrape data, run automation jobs, and pass results to any connected app. @@ -24,9 +24,9 @@ You can use the Albato integration to trigger a workflow whenever an Actor or a ## Connect Apify with Albato -### Step 1: Get your Apify API token +### Step 1: Create an Apify API token -Log in to [Apify Console](https://console.apify.com/) and go to **Settings > API & Integrations**. + ### Step 2: Create the Apify connection in Albato diff --git a/sources/platform/integrations/workflows-and-notifications/dify.md b/sources/platform/integrations/workflows-and-notifications/dify.md index 13704e7aba..2d13e0d51e 100644 --- a/sources/platform/integrations/workflows-and-notifications/dify.md +++ b/sources/platform/integrations/workflows-and-notifications/dify.md @@ -33,7 +33,7 @@ To connect your Apify account, configure the plugin using your Apify API token o ### API key 1. Open the plugin window and select **Add API Key**. -1. In the pop-up menu, paste your Apify API token. +1. In the pop-up menu, paste your Apify API token. 1. Select **Save**. ![Apify Auth in Dify](../images/dify-connection-popup.png) diff --git a/sources/platform/integrations/workflows-and-notifications/gumloop/index.md b/sources/platform/integrations/workflows-and-notifications/gumloop/index.md index e04b85c23a..8b8c43fae2 100644 --- a/sources/platform/integrations/workflows-and-notifications/gumloop/index.md +++ b/sources/platform/integrations/workflows-and-notifications/gumloop/index.md @@ -54,7 +54,7 @@ To use the Apify integration in Gumloop, you need an Apify account, a Gumloop ac 1. _Get your Apify API token_ - + 1. _Add Apify credentials to Gumloop_ diff --git a/sources/platform/integrations/workflows-and-notifications/make/ai-crawling.md b/sources/platform/integrations/workflows-and-notifications/make/ai-crawling.md index 543de18edf..634bac52e4 100644 --- a/sources/platform/integrations/workflows-and-notifications/make/ai-crawling.md +++ b/sources/platform/integrations/workflows-and-notifications/make/ai-crawling.md @@ -7,7 +7,7 @@ toc_max_heading_level: 4 --- import ThirdPartyDisclaimer from '@site/sources/_partials/_third-party-integration.mdx'; -import { CreateTokenStep, CopyTokenStep } from '@site/src/components/ApiToken'; +import { CreateApiTokenLink, CopyTokenStep } from '@site/src/components/ApiToken'; Use the Apify Scraper for AI Crawling module in [Make](https://www.make.com/) to extract clean Markdown from websites and feed AI models, RAG pipelines, or LLM frameworks at scale. @@ -25,9 +25,9 @@ To use these modules, you need an [Apify account](https://console.apify.com) and ![Sign up page](images/ai-crawling/wcc-signup.png) -1. To connect your Apify account to Make, you can use an OAuth connection (recommended) or an Apify API token. To get the token, go to **[Settings > API & Integrations](https://console.apify.com/settings/integrations)** in Apify Console. +1. To connect your Apify account to Make, you can use an OAuth connection (recommended) or an Apify API token. -1. +1. 1. Then, return to your Make scenario. 1. In Make, click **Add** to open the **Create a connection** dialog of the chosen Apify Scraper module. diff --git a/sources/platform/integrations/workflows-and-notifications/make/e-commerce.md b/sources/platform/integrations/workflows-and-notifications/make/e-commerce.md index 4087ad2fb9..ea0e30aaf8 100644 --- a/sources/platform/integrations/workflows-and-notifications/make/e-commerce.md +++ b/sources/platform/integrations/workflows-and-notifications/make/e-commerce.md @@ -7,7 +7,7 @@ toc_max_heading_level: 4 --- import ThirdPartyDisclaimer from '@site/sources/_partials/_third-party-integration.mdx'; -import { CreateTokenStep, CopyTokenStep } from '@site/src/components/ApiToken'; +import { CreateApiTokenLink, CopyTokenStep } from '@site/src/components/ApiToken'; Use the Apify E-commerce Scraping Tool module in [Make](https://www.make.com/) to extract product, review, seller, and influencer-storefront data from hundreds of retail sites and marketplaces. @@ -54,9 +54,7 @@ To connect your Apify account to Make, use an OAuth connection (recommended) or ### Connect with an API token -1. In Apify Console, open the **Settings > API & Integrations** tab at [console.apify.com/settings/integrations](https://console.apify.com/settings/integrations). - -1. +1. 1. Then, return to Make. 1. In Make, click **Add** to open the **Create a connection** dialog, select the **Apify API Token** connection type, paste the token into the **API token** field, name your connection, and click **Save**. diff --git a/sources/platform/integrations/workflows-and-notifications/make/index.md b/sources/platform/integrations/workflows-and-notifications/make/index.md index d2658c3b13..23d10b2746 100644 --- a/sources/platform/integrations/workflows-and-notifications/make/index.md +++ b/sources/platform/integrations/workflows-and-notifications/make/index.md @@ -32,7 +32,7 @@ Next, select one of the available options under Triggers, Actions and Searches, In the Connection configuration window, you'll authorize the connection between Make and Apify. The recommended method is to use an OAuth connection. Alternatively, you can choose to connect using Apify API token: -1. You will need to provide your Apify API token in the designated field. +1. You will need to provide your Apify API token in the designated field. ![API token](../../images/apify-token.png) diff --git a/sources/platform/integrations/workflows-and-notifications/make/llm.md b/sources/platform/integrations/workflows-and-notifications/make/llm.md index 78831160af..04b9e15404 100644 --- a/sources/platform/integrations/workflows-and-notifications/make/llm.md +++ b/sources/platform/integrations/workflows-and-notifications/make/llm.md @@ -7,7 +7,7 @@ toc_max_heading_level: 4 --- import ThirdPartyDisclaimer from '@site/sources/_partials/_third-party-integration.mdx'; -import { CreateTokenStep, CopyTokenStep } from '@site/src/components/ApiToken'; +import { CreateApiTokenLink, CopyTokenStep } from '@site/src/components/ApiToken'; Use the Apify Scraper for LLMs module in [Make](https://www.make.com/) to query Google Search, scrape the top results, and return clean Markdown for AI assistants and RAG pipelines. @@ -25,9 +25,9 @@ To use these modules, you need an [Apify account](https://console.apify.com) and ![Make interface showing API token field and connection name field for Apify integration setup](images/llm/rag-signup.png) -1. To connect your Apify account to Make, you can use an OAuth connection (recommended) or an Apify API token. To get the token, go to **[Settings > API & Integrations](https://console.apify.com/settings/integrations)** in Apify Console. +1. To connect your Apify account to Make, you can use an OAuth connection (recommended) or an Apify API token. -1. +1. 1. Then, return to your Make scenario. 1. In Make, click **Add** to open the **Create a connection** dialog of the chosen Apify Scraper module. diff --git a/sources/platform/integrations/workflows-and-notifications/n8n/index.md b/sources/platform/integrations/workflows-and-notifications/n8n/index.md index 73551a0a34..e7ac4fb97e 100644 --- a/sources/platform/integrations/workflows-and-notifications/n8n/index.md +++ b/sources/platform/integrations/workflows-and-notifications/n8n/index.md @@ -60,7 +60,7 @@ The Apify node offers two authentication methods to securely connect to your Api 1. In the n8n Editor UI, click on **Create Credential**. 1. Search for Apify API and click **Continue**. -1. Enter your Apify API token. +1. Enter your Apify API token. 1. Click **Save**. ![Apify Auth](../../images/n8n-api-auth.webp) diff --git a/sources/platform/integrations/workflows-and-notifications/n8n/website-content-crawler.md b/sources/platform/integrations/workflows-and-notifications/n8n/website-content-crawler.md index 772e33d97d..85dd6a1174 100644 --- a/sources/platform/integrations/workflows-and-notifications/n8n/website-content-crawler.md +++ b/sources/platform/integrations/workflows-and-notifications/n8n/website-content-crawler.md @@ -7,7 +7,7 @@ toc_max_heading_level: 4 --- import ThirdPartyDisclaimer from '@site/sources/_partials/_third-party-integration.mdx'; -import { CreateTokenStep, CopyTokenStep } from '@site/src/components/ApiToken'; +import { CreateApiTokenLink, CopyTokenStep } from '@site/src/components/ApiToken'; Website Content Crawler from [Apify](https://apify.com/apify/website-content-crawler) lets you extract text content from websites to feed AI models, LLM applications, vector databases, or Retrieval Augmented Generation (RAG) pipelines. It supports rich formatting using Markdown, cleans the HTML of irrelevant elements, downloads linked files, and integrates with AI ecosystems like Langchain, LlamaIndex, and other LLM frameworks. @@ -85,9 +85,9 @@ If you're running a self-hosted n8n instance, you can install the Apify communit ![Sign up page](../make/images/ai-crawling/wcc-signup.png) -1. To connect your Apify account to n8n, you can use an OAuth connection (recommended) or an Apify API token. To get the token, go to **[Settings > API & Integrations](https://console.apify.com/settings/integrations)** in Apify Console. +1. To connect your Apify account to n8n, you can use an OAuth connection (recommended) or an Apify API token. -1. +1. 1. Then, return to your n8n workflow interface. 1. In n8n, click **Create new credential** of the chosen Apify Scraper module. diff --git a/sources/platform/integrations/workflows-and-notifications/pipedream.md b/sources/platform/integrations/workflows-and-notifications/pipedream.md index 6c8f599c8e..f661adf600 100644 --- a/sources/platform/integrations/workflows-and-notifications/pipedream.md +++ b/sources/platform/integrations/workflows-and-notifications/pipedream.md @@ -26,7 +26,7 @@ Before you begin, make sure you have: ![Selecting the Apify app in Pipedream](../images/pipedream-select-app.png) - - **Apify** - Authenticate with a token. + - **Apify** - Authenticate with a token. - **Apify (OAuth)** - Authorize access to your Apify account via OAuth. 1. Follow the prompts to authenticate your account. diff --git a/sources/platform/integrations/workflows-and-notifications/telegram.md b/sources/platform/integrations/workflows-and-notifications/telegram.md index e5df658885..b2d1138f90 100644 --- a/sources/platform/integrations/workflows-and-notifications/telegram.md +++ b/sources/platform/integrations/workflows-and-notifications/telegram.md @@ -65,7 +65,7 @@ The connection configuration options open in a new tab in your browser or in a m In connection configuration, you need to provide your Apify API token. - + Paste the token into the configuration form and continue with the **Yes, Continue to Apify** button. diff --git a/sources/platform/integrations/workflows-and-notifications/viasocket.md b/sources/platform/integrations/workflows-and-notifications/viasocket.md index 9f0d9ef797..4c6760ae24 100644 --- a/sources/platform/integrations/workflows-and-notifications/viasocket.md +++ b/sources/platform/integrations/workflows-and-notifications/viasocket.md @@ -14,7 +14,7 @@ import CreateApiToken from '@site/sources/\_partials/\_create-api-token.mdx'; ## Step 1: Generate an Apify API token - + :::caution Token security Never share your API token publicly or commit it to version control. diff --git a/sources/platform/integrations/workflows-and-notifications/workato.md b/sources/platform/integrations/workflows-and-notifications/workato.md index f6239df519..7d31fb6aab 100644 --- a/sources/platform/integrations/workflows-and-notifications/workato.md +++ b/sources/platform/integrations/workflows-and-notifications/workato.md @@ -48,7 +48,7 @@ Before using the Apify connector in recipes, create a connection inside a Workat ![Screenshot showing how to create connection](../images/workato/create-connection.webp) 1. Search for **Apify** and choose the Apify connector. ![Screenshot showing how to search for the Apify connector in Workato](../images/workato/create-connection-find-connector.webp) -1. In the connection dialog, enter your **API Token**. +1. In the connection dialog, enter your **API Token**. ![Screenshot of the Workato API Key authentication form](../images/workato/create-connection-api-key.webp) 1. Click **Connect**. Workato tests the connection by making an authenticated call to verify your credentials. ![Screenshot showing successful API Key authentication in Workato](../images/workato/create-connection-api-success.webp) diff --git a/src/components/ApiToken.jsx b/src/components/ApiToken.jsx index 8b85a59551..9d830a4396 100644 --- a/src/components/ApiToken.jsx +++ b/src/components/ApiToken.jsx @@ -4,29 +4,30 @@ import Link from '@docusaurus/Link'; // integration pages. They render inline, so they work inside list items and // bullets without breaking the surrounding list. -const CREATE_TOKEN_URL = '/integrations/api#create-api-token'; +// Opens the create token form in Apify Console. +const CREATE_TOKEN_URL = 'https://console.apify.com/settings/integrations?createApiToken=true'; -// Prerequisite bullets: "- _Apify API token_ - " -export const CreateApiTokenLink = () => ( - <> - Create an API token in Apify Console. - -); +// `description` prefills the token description in the form, e.g. "Make.com". +const createTokenUrl = (description) => + description ? `${CREATE_TOKEN_URL}&for=${encodeURIComponent(description)}` : CREATE_TOKEN_URL; -// Tail of a step that asks for the token: "1. Enter your token in the field. " -export const GetApiTokenHint = () => ( +// Link to the create token form with custom text: "create one in Apify Console" +export const CreateTokenLink = ({ description, children }) => {children}; + +// Prerequisite bullets: "- _Apify API token_ - " +export const CreateApiTokenLink = ({ description }) => ( <> - To get one, create an API token in Apify Console and copy it. + Create an API token in Apify Console. ); -// Step after navigating to Settings > API & Integrations: "1. " -export const CreateTokenStep = () => ( +// Tail of a step that asks for the token: "1. Enter your token in the field. " +export const GetApiTokenHint = ({ description }) => ( <> - In the Personal API tokens section, select Create a new token. Enter a - description, optionally limit the token's permissions, and select Create. + To get one, create an API token in Apify Console and + copy it. ); -// Step after CreateTokenStep: "1. Then, return to your Make scenario." +// Step after CreateApiTokenLink: "1. " export const CopyTokenStep = () => <>Copy the token. You can view it only once, so store it somewhere safe.; From 73c24c67e81e4adf9f9709fc17424786f06ac5fa Mon Sep 17 00:00:00 2001 From: Marcel Rebro Date: Fri, 20 Nov 2026 14:33:08 +0100 Subject: [PATCH 2/3] docs: keep only the create token link and broken link fixes Revert the rewording of token steps, Academy tutorials, the API pages, and the OpenAPI authentication text. Restore the manual token step component used by the Make, n8n, and Albato walkthroughs. Co-Authored-By: Claude Opus 5.5 --- .../openapi/components/securitySchemes/apiKey.yaml | 2 +- .../openapi/components/securitySchemes/httpBearer.yaml | 2 +- apify-api/openapi/openapi.yaml | 6 +++--- .../academy/platform/getting_started/apify_client.md | 2 +- .../api/run_actor_and_retrieve_data_via_api.md | 4 ++-- sources/api/getting-started.mdx | 2 +- sources/platform/actors/running/schedules.md | 2 +- sources/platform/integrations/ai/llama.md | 3 +-- sources/platform/integrations/programming/api.md | 3 ++- .../integrations/workflows-and-notifications/albato.md | 6 +++--- .../workflows-and-notifications/make/ai-crawling.md | 6 +++--- .../workflows-and-notifications/make/e-commerce.md | 6 ++++-- .../workflows-and-notifications/make/llm.md | 6 +++--- .../n8n/website-content-crawler.md | 6 +++--- src/components/ApiToken.jsx | 10 +++++++++- 15 files changed, 38 insertions(+), 28 deletions(-) diff --git a/apify-api/openapi/components/securitySchemes/apiKey.yaml b/apify-api/openapi/components/securitySchemes/apiKey.yaml index 3108b8c8ac..708edef8a0 100644 --- a/apify-api/openapi/components/securitySchemes/apiKey.yaml +++ b/apify-api/openapi/components/securitySchemes/apiKey.yaml @@ -4,7 +4,7 @@ in: query description: |- API token provided as a query parameter (e.g., `?token=your_token`—less secure). - Use your API token to authenticate requests. [Create one in Apify Console](https://console.apify.com/settings/integrations?createApiToken=true). The Console shows the token only once, right after you create or rotate it, so copy it and store it somewhere safe. + Use your API token to authenticate requests. You can create one on the [Integrations page](https://console.apify.com/settings/integrations) in Apify Console. The Console shows the token only once, right after you create or rotate it, so copy it and store it somewhere safe. :::danger Security diff --git a/apify-api/openapi/components/securitySchemes/httpBearer.yaml b/apify-api/openapi/components/securitySchemes/httpBearer.yaml index d44ca16546..9a9f82678c 100644 --- a/apify-api/openapi/components/securitySchemes/httpBearer.yaml +++ b/apify-api/openapi/components/securitySchemes/httpBearer.yaml @@ -3,7 +3,7 @@ scheme: bearer description: |- Bearer token provided in the `Authorization` header (e.g., `Authorization: Bearer your_token`—recommended). For details, see the [`Authorization` header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization) on MDN. - Use your API token to authenticate requests. [Create one in Apify Console](https://console.apify.com/settings/integrations?createApiToken=true). The Console shows the token only once, right after you create or rotate it, so copy it and store it somewhere safe. This method is more secure than query parameters, as headers are not logged in browser history or server logs. + Use your API token to authenticate requests. You can create one on the [Integrations page](https://console.apify.com/settings/integrations) in Apify Console. The Console shows the token only once, right after you create or rotate it, so copy it and store it somewhere safe. This method is more secure than query parameters, as headers are not logged in browser history or server logs. :::danger Security diff --git a/apify-api/openapi/openapi.yaml b/apify-api/openapi/openapi.yaml index bd96c76e8e..cb4c66927d 100644 --- a/apify-api/openapi/openapi.yaml +++ b/apify-api/openapi/openapi.yaml @@ -47,9 +47,9 @@ info: ## Authentication - **You can [create an API token in Apify - Console](https://console.apify.com/settings/integrations?createApiToken=true).** - The Console shows the token only once, right after you create + **You can create an API token on the + [Integrations](https://console.apify.com/settings/integrations) page in the + Apify Console.** The Console shows the token only once, right after you create or rotate it, so copy it and store it somewhere safe. For details, see [API token](https://docs.apify.com/integrations/api#api-token). diff --git a/sources/academy/platform/getting_started/apify_client.md b/sources/academy/platform/getting_started/apify_client.md index ca123c34c5..5fae8be32c 100644 --- a/sources/academy/platform/getting_started/apify_client.md +++ b/sources/academy/platform/getting_started/apify_client.md @@ -62,7 +62,7 @@ from apify_client import ApifyClient In the last lesson, we ran the **adding-actor** and retrieved its dataset items. That's exactly what we're going to do now; however, by using the Apify client instead. -Before we can use the client, we must create a new instance of the `ApifyClient` class and pass it our API token. If you don't have a token stored, [create one in Apify Console](https://console.apify.com/settings/integrations?createApiToken=true&asrc=developers_portal) and copy it. +Before we can use the client, we must create a new instance of the `ApifyClient` class and pass it our API token. If you don't have a token stored, [create one](/integrations/api#create-api-token) on the [**API & Integrations** page](https://console.apify.com/settings/integrations?asrc=developers_portal) in Apify Console and copy it. diff --git a/sources/academy/tutorials/api/run_actor_and_retrieve_data_via_api.md b/sources/academy/tutorials/api/run_actor_and_retrieve_data_via_api.md index 82a5a89df8..359b17d418 100644 --- a/sources/academy/tutorials/api/run_actor_and_retrieve_data_via_api.md +++ b/sources/academy/tutorials/api/run_actor_and_retrieve_data_via_api.md @@ -33,7 +33,7 @@ To run, or **call**, an Actor/task, you will need a few things: - The name or ID of the Actor/task. The name looks like `username~actorName` or `username~taskName`. The ID can be retrieved on the **Settings** page of the Actor/task. -- Your [API token](/integrations/api#create-api-token), which you can [create in Apify Console](https://console.apify.com/settings/integrations?createApiToken=true). Apify Console shows the token only once, so copy it right away. Don't share it with anyone. +- Your [API token](/integrations/api#create-api-token), which you can create on the **API & Integrations** page in [Apify Console](https://console.apify.com/settings/integrations). Apify Console shows the token only once, so copy it right away. Don't share it with anyone. - Possibly an input, which is passed in JSON format as the request's **body**. @@ -158,7 +158,7 @@ Here is a Node.js example of calling a task via the API and logging the dataset import got from 'got'; // Specify your API token -// (create one at https://console.apify.com/settings/integrations?createApiToken=true) +// (create one at https://console.apify.com/settings/integrations) const myToken = 'YOUR_API_TOKEN'; // Start apify/google-search-scraper Actor diff --git a/sources/api/getting-started.mdx b/sources/api/getting-started.mdx index 951470875e..59e8826df4 100644 --- a/sources/api/getting-started.mdx +++ b/sources/api/getting-started.mdx @@ -29,7 +29,7 @@ The diagram illustrates the basic workflow when using the Apify API: Before you can start using the API, check if you have all the necessary prerequisites: -* An Apify account with an API token ([create one in Apify Console](https://console.apify.com/settings/integrations?createApiToken=true)). Most requests need to be authenticated with the Apify API token passed via the `Authorization` HTTP header. For details, see [Authentication](/api/v2#authentication). +* An Apify account with an API token. Most requests need to be authenticated with the Apify API token passed via the `Authorization` HTTP header. For details, see [Authentication](/api/v2#authentication). * A tool to make HTTP requests (cURL, Postman, or your preferred programming language). ### Verify your access diff --git a/sources/platform/actors/running/schedules.md b/sources/platform/actors/running/schedules.md index 84ce9c9790..fbda03e4cd 100644 --- a/sources/platform/actors/running/schedules.md +++ b/sources/platform/actors/running/schedules.md @@ -80,7 +80,7 @@ To authenticate, use a secret API token. When providing your API authentication token, we recommend using the request's `Authorization` header, rather than the URL. For details, see [Authentication](/api/v2#authentication). ::: -In the `POST` request's payload should be a JSON object specifying the schedule's name, your user ID (on the [**API & Integrations**](https://console.apify.com/settings/integrations) page of your account settings), and the schedule's _actions_. +In the `POST` request's payload should be a JSON object specifying the schedule's name, your [user ID](https://console.apify.com/settings/integrations), and the schedule's _actions_. The following JSON object creates a schedule which runs an SEO audit of the Apify domain once a month. diff --git a/sources/platform/integrations/ai/llama.md b/sources/platform/integrations/ai/llama.md index f55ae8fa2b..f0c4a1a0e7 100644 --- a/sources/platform/integrations/ai/llama.md +++ b/sources/platform/integrations/ai/llama.md @@ -6,7 +6,6 @@ slug: /integrations/llama-index --- import ThirdPartyDisclaimer from '@site/sources/_partials/_third-party-integration.mdx'; -import { GetApiTokenHint } from '@site/src/components/ApiToken'; > For more information on LlamaIndex, visit its [documentation](https://developers.llamaindex.ai/python/framework/). @@ -28,7 +27,7 @@ After successfully installing all dependencies, we can start writing Python code ### Apify Actor -To use the Apify Actor, import `ApifyActor` and `Document`, and set your [Apify API token](https://docs.apify.com/integrations/api#api-token) in the code. +To use the Apify Actor, import `ApifyActor` and `Document`, and set your [Apify API token](https://docs.apify.com/integrations/api#api-token) in the code. The following example uses the [Website Content Crawler](https://apify.com/apify/website-content-crawler) Actor to crawl an entire website, which will extract text content from the web pages. The extracted text is formatted as a llama_index `Document` and can be fed to a vector store or language model like GPT. diff --git a/sources/platform/integrations/programming/api.md b/sources/platform/integrations/programming/api.md index 34c2db007e..ab4ded0289 100644 --- a/sources/platform/integrations/programming/api.md +++ b/sources/platform/integrations/programming/api.md @@ -28,7 +28,8 @@ unless you fully understand the consequences! You can also consider [limiting t ### Create an API token {#create-api-token} -1. Open the [create token form](https://console.apify.com/settings/integrations?createApiToken=true) in Apify Console. Alternatively, go to **Settings > API & Integrations** and select **Create a new token** in the **Personal API tokens** section. +1. Go to [**Settings > API & Integrations**](https://console.apify.com/settings/integrations) in Apify Console. +1. In the **Personal API tokens** section, select **Create a new token**. 1. Enter a description. Optionally, [limit the token's permissions](#limited-permissions) or [set an expiration date](#expiration). 1. Select **Create**. 1. Copy the token and store it somewhere safe, such as a password manager. diff --git a/sources/platform/integrations/workflows-and-notifications/albato.md b/sources/platform/integrations/workflows-and-notifications/albato.md index f28f2d5120..656685f6ac 100644 --- a/sources/platform/integrations/workflows-and-notifications/albato.md +++ b/sources/platform/integrations/workflows-and-notifications/albato.md @@ -7,7 +7,7 @@ slug: /integrations/albato --- import ThirdPartyDisclaimer from '@site/sources/_partials/_third-party-integration.mdx'; -import { CreateApiTokenLink, CopyTokenStep } from '@site/src/components/ApiToken'; +import { CreateTokenStep, CopyTokenStep } from '@site/src/components/ApiToken'; [Albato](https://albato.com/automate) is a no-code integration platform that connects over 1,000 apps through a visual automation builder. With [Apify integration for Albato](https://albato.com/apps/apify), you can use Apify Actors as triggers or actions inside your Albato workflows to scrape data, run automation jobs, and pass results to any connected app. @@ -24,9 +24,9 @@ You can use the Albato integration to trigger a workflow whenever an Actor or a ## Connect Apify with Albato -### Step 1: Create an Apify API token +### Step 1: Get your Apify API token - +Log in to [Apify Console](https://console.apify.com/) and go to **Settings > API & Integrations**. ### Step 2: Create the Apify connection in Albato diff --git a/sources/platform/integrations/workflows-and-notifications/make/ai-crawling.md b/sources/platform/integrations/workflows-and-notifications/make/ai-crawling.md index 634bac52e4..543de18edf 100644 --- a/sources/platform/integrations/workflows-and-notifications/make/ai-crawling.md +++ b/sources/platform/integrations/workflows-and-notifications/make/ai-crawling.md @@ -7,7 +7,7 @@ toc_max_heading_level: 4 --- import ThirdPartyDisclaimer from '@site/sources/_partials/_third-party-integration.mdx'; -import { CreateApiTokenLink, CopyTokenStep } from '@site/src/components/ApiToken'; +import { CreateTokenStep, CopyTokenStep } from '@site/src/components/ApiToken'; Use the Apify Scraper for AI Crawling module in [Make](https://www.make.com/) to extract clean Markdown from websites and feed AI models, RAG pipelines, or LLM frameworks at scale. @@ -25,9 +25,9 @@ To use these modules, you need an [Apify account](https://console.apify.com) and ![Sign up page](images/ai-crawling/wcc-signup.png) -1. To connect your Apify account to Make, you can use an OAuth connection (recommended) or an Apify API token. +1. To connect your Apify account to Make, you can use an OAuth connection (recommended) or an Apify API token. To get the token, go to **[Settings > API & Integrations](https://console.apify.com/settings/integrations)** in Apify Console. -1. +1. 1. Then, return to your Make scenario. 1. In Make, click **Add** to open the **Create a connection** dialog of the chosen Apify Scraper module. diff --git a/sources/platform/integrations/workflows-and-notifications/make/e-commerce.md b/sources/platform/integrations/workflows-and-notifications/make/e-commerce.md index ea0e30aaf8..4087ad2fb9 100644 --- a/sources/platform/integrations/workflows-and-notifications/make/e-commerce.md +++ b/sources/platform/integrations/workflows-and-notifications/make/e-commerce.md @@ -7,7 +7,7 @@ toc_max_heading_level: 4 --- import ThirdPartyDisclaimer from '@site/sources/_partials/_third-party-integration.mdx'; -import { CreateApiTokenLink, CopyTokenStep } from '@site/src/components/ApiToken'; +import { CreateTokenStep, CopyTokenStep } from '@site/src/components/ApiToken'; Use the Apify E-commerce Scraping Tool module in [Make](https://www.make.com/) to extract product, review, seller, and influencer-storefront data from hundreds of retail sites and marketplaces. @@ -54,7 +54,9 @@ To connect your Apify account to Make, use an OAuth connection (recommended) or ### Connect with an API token -1. +1. In Apify Console, open the **Settings > API & Integrations** tab at [console.apify.com/settings/integrations](https://console.apify.com/settings/integrations). + +1. 1. Then, return to Make. 1. In Make, click **Add** to open the **Create a connection** dialog, select the **Apify API Token** connection type, paste the token into the **API token** field, name your connection, and click **Save**. diff --git a/sources/platform/integrations/workflows-and-notifications/make/llm.md b/sources/platform/integrations/workflows-and-notifications/make/llm.md index 04b9e15404..78831160af 100644 --- a/sources/platform/integrations/workflows-and-notifications/make/llm.md +++ b/sources/platform/integrations/workflows-and-notifications/make/llm.md @@ -7,7 +7,7 @@ toc_max_heading_level: 4 --- import ThirdPartyDisclaimer from '@site/sources/_partials/_third-party-integration.mdx'; -import { CreateApiTokenLink, CopyTokenStep } from '@site/src/components/ApiToken'; +import { CreateTokenStep, CopyTokenStep } from '@site/src/components/ApiToken'; Use the Apify Scraper for LLMs module in [Make](https://www.make.com/) to query Google Search, scrape the top results, and return clean Markdown for AI assistants and RAG pipelines. @@ -25,9 +25,9 @@ To use these modules, you need an [Apify account](https://console.apify.com) and ![Make interface showing API token field and connection name field for Apify integration setup](images/llm/rag-signup.png) -1. To connect your Apify account to Make, you can use an OAuth connection (recommended) or an Apify API token. +1. To connect your Apify account to Make, you can use an OAuth connection (recommended) or an Apify API token. To get the token, go to **[Settings > API & Integrations](https://console.apify.com/settings/integrations)** in Apify Console. -1. +1. 1. Then, return to your Make scenario. 1. In Make, click **Add** to open the **Create a connection** dialog of the chosen Apify Scraper module. diff --git a/sources/platform/integrations/workflows-and-notifications/n8n/website-content-crawler.md b/sources/platform/integrations/workflows-and-notifications/n8n/website-content-crawler.md index 85dd6a1174..772e33d97d 100644 --- a/sources/platform/integrations/workflows-and-notifications/n8n/website-content-crawler.md +++ b/sources/platform/integrations/workflows-and-notifications/n8n/website-content-crawler.md @@ -7,7 +7,7 @@ toc_max_heading_level: 4 --- import ThirdPartyDisclaimer from '@site/sources/_partials/_third-party-integration.mdx'; -import { CreateApiTokenLink, CopyTokenStep } from '@site/src/components/ApiToken'; +import { CreateTokenStep, CopyTokenStep } from '@site/src/components/ApiToken'; Website Content Crawler from [Apify](https://apify.com/apify/website-content-crawler) lets you extract text content from websites to feed AI models, LLM applications, vector databases, or Retrieval Augmented Generation (RAG) pipelines. It supports rich formatting using Markdown, cleans the HTML of irrelevant elements, downloads linked files, and integrates with AI ecosystems like Langchain, LlamaIndex, and other LLM frameworks. @@ -85,9 +85,9 @@ If you're running a self-hosted n8n instance, you can install the Apify communit ![Sign up page](../make/images/ai-crawling/wcc-signup.png) -1. To connect your Apify account to n8n, you can use an OAuth connection (recommended) or an Apify API token. +1. To connect your Apify account to n8n, you can use an OAuth connection (recommended) or an Apify API token. To get the token, go to **[Settings > API & Integrations](https://console.apify.com/settings/integrations)** in Apify Console. -1. +1. 1. Then, return to your n8n workflow interface. 1. In n8n, click **Create new credential** of the chosen Apify Scraper module. diff --git a/src/components/ApiToken.jsx b/src/components/ApiToken.jsx index 9d830a4396..4fa75d9416 100644 --- a/src/components/ApiToken.jsx +++ b/src/components/ApiToken.jsx @@ -29,5 +29,13 @@ export const GetApiTokenHint = ({ description }) => ( ); -// Step after CreateApiTokenLink: "1. " +// Step after navigating to Settings > API & Integrations: "1. " +export const CreateTokenStep = () => ( + <> + In the Personal API tokens section, select Create a new token. Enter a + description, optionally limit the token's permissions, and select Create. + +); + +// Step after CreateTokenStep: "1. Then, return to your Make scenario." export const CopyTokenStep = () => <>Copy the token. You can view it only once, so store it somewhere safe.; From 547f093153bcfcab0033b53cbe940d426905aac8 Mon Sep 17 00:00:00 2001 From: Marcel Rebro Date: Fri, 20 Nov 2026 14:34:34 +0100 Subject: [PATCH 3/3] docs: name the token link prop after the integration The prop fills the `for` parameter, which names what the token is for. Calling it `description` would clash with the separate token name field Console is adding. Co-Authored-By: Claude Opus 5.5 --- sources/_partials/_create-api-token.mdx | 2 +- .../integrations/agents/antigravity.md | 2 +- .../agents/claude/claude-code-cli.md | 2 +- sources/platform/integrations/agents/cursor.md | 2 +- .../integrations/agents/deepseek-harness.md | 2 +- .../github-copilot/github-copilot-cli.md | 2 +- .../platform/integrations/agents/grok-bot.md | 2 +- .../platform/integrations/agents/grok-build.md | 2 +- .../integrations/agents/hermes-agent.md | 2 +- .../integrations/agents/kimi-code-cli.md | 2 +- .../platform/integrations/agents/lovable.md | 2 +- sources/platform/integrations/agents/manus.md | 2 +- .../integrations/agents/openai/chatgpt.md | 2 +- .../integrations/agents/openai/codex-app.md | 2 +- .../integrations/agents/openai/codex-cli.md | 2 +- .../platform/integrations/agents/openclaw.md | 2 +- .../platform/integrations/agents/opencode.md | 2 +- .../platform/integrations/agents/qoder/qwen.md | 2 +- sources/platform/integrations/ai/agno.md | 2 +- sources/platform/integrations/ai/crewai.md | 2 +- sources/platform/integrations/ai/flowise.md | 2 +- sources/platform/integrations/ai/google-adk.md | 2 +- .../integrations/ai/langchain/langgraph.md | 2 +- sources/platform/integrations/ai/langflow.md | 2 +- sources/platform/integrations/ai/mastra.md | 2 +- .../integrations/ai/openai/openai-agents.md | 2 +- sources/platform/integrations/ai/upsonic.md | 2 +- .../platform/integrations/ai/vercel-ai-sdk.md | 2 +- .../integrations/data-and-storage/airbyte.md | 2 +- .../integrations/data-and-storage/keboola.md | 2 +- .../integrations/programming/github.md | 2 +- .../activepieces.md | 2 +- .../workflows-and-notifications/dify.md | 2 +- .../gumloop/index.md | 2 +- .../workflows-and-notifications/make/index.md | 2 +- .../workflows-and-notifications/n8n/index.md | 2 +- .../workflows-and-notifications/pipedream.md | 2 +- .../workflows-and-notifications/telegram.md | 2 +- .../workflows-and-notifications/viasocket.md | 2 +- .../workflows-and-notifications/workato.md | 2 +- src/components/ApiToken.jsx | 18 +++++++++--------- 41 files changed, 49 insertions(+), 49 deletions(-) diff --git a/sources/_partials/_create-api-token.mdx b/sources/_partials/_create-api-token.mdx index 3006864ccf..08b1464ae8 100644 --- a/sources/_partials/_create-api-token.mdx +++ b/sources/_partials/_create-api-token.mdx @@ -1,3 +1,3 @@ import { CreateTokenLink } from '@site/src/components/ApiToken'; -To get an API token, create one in Apify Console and copy it. You can view it only once, so store it somewhere safe, such as a password manager. If you lose it, [rotate the token](/integrations/api#rotation) or create a new one. +To get an API token, create one in Apify Console and copy it. You can view it only once, so store it somewhere safe, such as a password manager. If you lose it, [rotate the token](/integrations/api#rotation) or create a new one. diff --git a/sources/platform/integrations/agents/antigravity.md b/sources/platform/integrations/agents/antigravity.md index 2a807d2868..c5b0074aca 100644 --- a/sources/platform/integrations/agents/antigravity.md +++ b/sources/platform/integrations/agents/antigravity.md @@ -110,7 +110,7 @@ With the default permission preset, Antigravity runs agent commands in a [termin The MCP sign-in doesn't need a browser on the machine that runs Antigravity. Over SSH or in a container, open the sign-in link that Antigravity shows in a browser on any machine, then paste the authorization code back at the `agy` prompt. -If you can't use OAuth at all, use the skills that don't need the MCP server and authenticate them with a token. Set it before starting Antigravity: +If you can't use OAuth at all, use the skills that don't need the MCP server and authenticate them with a token. Set it before starting Antigravity: ```bash export APIFY_TOKEN= diff --git a/sources/platform/integrations/agents/claude/claude-code-cli.md b/sources/platform/integrations/agents/claude/claude-code-cli.md index dc0fbfcfc5..5cac82fb0f 100644 --- a/sources/platform/integrations/agents/claude/claude-code-cli.md +++ b/sources/platform/integrations/agents/claude/claude-code-cli.md @@ -145,7 +145,7 @@ Plugins require a local installation of the Claude Code CLI. They aren't availab If the browser doesn't open automatically, copy the OAuth URL shown in the terminal and paste it into your browser manually. -If you're running Claude Code in a headless environment (SSH, remote container) or the OAuth flow still fails, use token authentication instead. Set it before starting Claude Code: +If you're running Claude Code in a headless environment (SSH, remote container) or the OAuth flow still fails, use token authentication instead. Set it before starting Claude Code: ```bash export APIFY_TOKEN= diff --git a/sources/platform/integrations/agents/cursor.md b/sources/platform/integrations/agents/cursor.md index e0af9b8fbd..76049e202c 100644 --- a/sources/platform/integrations/agents/cursor.md +++ b/sources/platform/integrations/agents/cursor.md @@ -106,7 +106,7 @@ Start your request with `@apify` so the routing agent handles it. The agent owns If the browser doesn't open automatically, copy the OAuth URL shown by Cursor and paste it into your browser manually. -If you're running Cursor in a remote session, devcontainer, or over SSH where no browser is available, use token authentication instead. Set it in your environment before starting Cursor: +If you're running Cursor in a remote session, devcontainer, or over SSH where no browser is available, use token authentication instead. Set it in your environment before starting Cursor: ```bash export APIFY_TOKEN= diff --git a/sources/platform/integrations/agents/deepseek-harness.md b/sources/platform/integrations/agents/deepseek-harness.md index d7dc3099bf..05b1a19b78 100644 --- a/sources/platform/integrations/agents/deepseek-harness.md +++ b/sources/platform/integrations/agents/deepseek-harness.md @@ -70,7 +70,7 @@ The plugin enables the Apify MCP server on install. Searching Apify Store, inspe `dsh` sends static MCP headers and has no OAuth flow, so authenticate with an API token: -1. +1. 1. Create a `.env` file in the directory you launch `dsh` from: diff --git a/sources/platform/integrations/agents/github-copilot/github-copilot-cli.md b/sources/platform/integrations/agents/github-copilot/github-copilot-cli.md index ea96fd4cd4..1bfd8b6ede 100644 --- a/sources/platform/integrations/agents/github-copilot/github-copilot-cli.md +++ b/sources/platform/integrations/agents/github-copilot/github-copilot-cli.md @@ -113,7 +113,7 @@ On the first start, Copilot may report that `apify-mcp-server` is taking longer If the browser doesn't open automatically, copy the OAuth URL shown in the terminal and paste it into your browser manually. -If you're running the CLI in a headless environment (SSH, remote container) or the OAuth flow still fails, use token authentication instead. Set it before starting the CLI: +If you're running the CLI in a headless environment (SSH, remote container) or the OAuth flow still fails, use token authentication instead. Set it before starting the CLI: ```bash export APIFY_TOKEN= diff --git a/sources/platform/integrations/agents/grok-bot.md b/sources/platform/integrations/agents/grok-bot.md index 2764ddf8c6..bbce8321d7 100644 --- a/sources/platform/integrations/agents/grok-bot.md +++ b/sources/platform/integrations/agents/grok-bot.md @@ -106,7 +106,7 @@ Open **Settings** > **Plugins**, find the **Apify** connector, and complete auth If the browser doesn't open automatically, copy the OAuth URL shown by Grok Bot and paste it into your browser manually. -If the OAuth flow still fails, use token authentication instead. Set it on the Grok Bot computer: +If the OAuth flow still fails, use token authentication instead. Set it on the Grok Bot computer: ```bash export APIFY_TOKEN= diff --git a/sources/platform/integrations/agents/grok-build.md b/sources/platform/integrations/agents/grok-build.md index 2e61caed89..fb671ba6a2 100644 --- a/sources/platform/integrations/agents/grok-build.md +++ b/sources/platform/integrations/agents/grok-build.md @@ -99,7 +99,7 @@ If the OAuth flow still can't complete, for example because no browser is availa apify login ``` -In a non-interactive environment, use token authentication instead. Then pass it to `apify login`: +In a non-interactive environment, use token authentication instead. Then pass it to `apify login`: ```bash apify login -t diff --git a/sources/platform/integrations/agents/hermes-agent.md b/sources/platform/integrations/agents/hermes-agent.md index 03ba1fd3a0..8f3f6137ac 100644 --- a/sources/platform/integrations/agents/hermes-agent.md +++ b/sources/platform/integrations/agents/hermes-agent.md @@ -20,7 +20,7 @@ For more details about Hermes Agent, refer to the [official documentation](https Before integrating Apify with Hermes Agent, you'll need: - _An Apify account_ - If you don't have one, [sign up here](https://console.apify.com/sign-up). -- _Apify API token_ - +- _Apify API token_ - - _Hermes Agent_ - Version 0.18.1 or later. Install the CLI from the [official documentation](https://hermes-agent.nousresearch.com/docs). - _Python 3.11 to 3.13_ - Required to install the plugin. diff --git a/sources/platform/integrations/agents/kimi-code-cli.md b/sources/platform/integrations/agents/kimi-code-cli.md index 136f4ed602..7ab5b71f28 100644 --- a/sources/platform/integrations/agents/kimi-code-cli.md +++ b/sources/platform/integrations/agents/kimi-code-cli.md @@ -149,7 +149,7 @@ Run `/mcp-config login apify` explicitly rather than waiting for an automatic pr If you're running Kimi Code in a headless environment (SSH, remote container) or in non-interactive prompt mode (`kimi -p`), the OAuth handshake can't complete. Authenticate on a machine with a browser first, then point the headless machine at the same `KIMI_CODE_HOME` so it picks up `credentials/mcp/`. Alternatively, override the `apify` entry in `~/.kimi-code/mcp.json` or `.kimi-code/mcp.json` with a static token - a project-level entry with the same name overrides the plugin's declaration. -For the CLI and SDK skills, use token authentication. Export it before starting Kimi Code: +For the CLI and SDK skills, use token authentication. Export it before starting Kimi Code: ```bash export APIFY_TOKEN= diff --git a/sources/platform/integrations/agents/lovable.md b/sources/platform/integrations/agents/lovable.md index d085167090..0073461540 100644 --- a/sources/platform/integrations/agents/lovable.md +++ b/sources/platform/integrations/agents/lovable.md @@ -24,7 +24,7 @@ Apify is available as an app and chat connector: one connection works both in th Before you connect the two platforms, you need: - _An Apify account_ - If you don't have one, [sign up here](https://console.apify.com/sign-up). -- _Apify API token_ - See [API token](/integrations/api#api-token) for scope and expiration options. +- _Apify API token_ - See [API token](/integrations/api#api-token) for scope and expiration options. - _A Lovable account_ - App and chat connectors are available on the Free, Pro, and Business plans. - _Permission to create connections_ - Enterprise plans restrict connection creation to **No one** by default, until an admin changes it in **Connectors > Admin settings > App + chat connectors**. diff --git a/sources/platform/integrations/agents/manus.md b/sources/platform/integrations/agents/manus.md index 92ec75b5d5..f747e9d993 100644 --- a/sources/platform/integrations/agents/manus.md +++ b/sources/platform/integrations/agents/manus.md @@ -173,7 +173,7 @@ Manus will load the skill instructions and use the appropriate Apify Actors to c If the OAuth prompt fails or you can't complete the login flow, you can connect using your Apify API token directly. -1. +1. 1. In Manus, open the Apify connector settings and add a custom header: - **Header name** - `Authorization` - **Header value** - `Bearer ` (replace `` with your actual token) diff --git a/sources/platform/integrations/agents/openai/chatgpt.md b/sources/platform/integrations/agents/openai/chatgpt.md index 68e0e0dc32..71b5faabd0 100644 --- a/sources/platform/integrations/agents/openai/chatgpt.md +++ b/sources/platform/integrations/agents/openai/chatgpt.md @@ -25,7 +25,7 @@ In this tutorial, you'll learn how to connect _ChatGPT_ to the _Apify MCP server Before connecting ChatGPT to Apify, you'll need: - _An Apify account_ - If you don't have an Apify account already, you can [sign up](https://console.apify.com/sign-up) -- _Apify API token_ - This token authorizes the MCP server to run Actors on your behalf. +- _Apify API token_ - This token authorizes the MCP server to run Actors on your behalf. - _An OpenAI account with access to ChatGPT_ - You need an OpenAI account to use ChatGPT. - _ChatGPT with Developer mode enabled_ - You must enable [Developer Mode](https://platform.openai.com/docs/guides/developer-mode) to add custom connectors (when the Developer mode is active, the message input box is outlined in orange). diff --git a/sources/platform/integrations/agents/openai/codex-app.md b/sources/platform/integrations/agents/openai/codex-app.md index 48189d805e..94b4f5924f 100644 --- a/sources/platform/integrations/agents/openai/codex-app.md +++ b/sources/platform/integrations/agents/openai/codex-app.md @@ -107,7 +107,7 @@ Plugins require a local installation of Codex with plugin support enabled. Insta If the browser doesn't open automatically, copy the OAuth URL shown by Codex and paste it into your browser manually. -If you're running Codex in a headless environment (SSH, remote container) or the OAuth flow still fails, use token authentication instead. Set it before starting Codex: +If you're running Codex in a headless environment (SSH, remote container) or the OAuth flow still fails, use token authentication instead. Set it before starting Codex: ```bash export APIFY_TOKEN= diff --git a/sources/platform/integrations/agents/openai/codex-cli.md b/sources/platform/integrations/agents/openai/codex-cli.md index 464f214379..9a0a08e788 100644 --- a/sources/platform/integrations/agents/openai/codex-cli.md +++ b/sources/platform/integrations/agents/openai/codex-cli.md @@ -105,7 +105,7 @@ Reopen `/plugins`, move to the **Apify Plugin** tab, and confirm the marketplace If the browser doesn't open automatically, copy the OAuth URL shown in the terminal and paste it into your browser manually. -If you're running the Codex CLI in a headless environment (SSH, remote container) or the OAuth flow still fails, use token authentication instead. Set it before starting Codex: +If you're running the Codex CLI in a headless environment (SSH, remote container) or the OAuth flow still fails, use token authentication instead. Set it before starting Codex: ```bash export APIFY_TOKEN= diff --git a/sources/platform/integrations/agents/openclaw.md b/sources/platform/integrations/agents/openclaw.md index 6832b2579e..1e89e42268 100644 --- a/sources/platform/integrations/agents/openclaw.md +++ b/sources/platform/integrations/agents/openclaw.md @@ -34,7 +34,7 @@ Watch a quick demo of the Apify plugin for OpenClaw: Before integrating Apify with OpenClaw, you'll need: - _An Apify account_ - If you don't have one, [sign up here](https://console.apify.com/sign-up). -- _Apify API token_ - +- _Apify API token_ - - _OpenClaw_ - Version 2026.1.0 or later. Install from the [OpenClaw website](https://openclaw.io/). - _Node.js 22+_ - Required to run the plugin. Install from [nodejs.org](https://nodejs.org/en/download/). diff --git a/sources/platform/integrations/agents/opencode.md b/sources/platform/integrations/agents/opencode.md index 84b2e0f049..5164e6c1f5 100644 --- a/sources/platform/integrations/agents/opencode.md +++ b/sources/platform/integrations/agents/opencode.md @@ -97,7 +97,7 @@ Check that `opencode-apify` is listed under `plugin`. If it's missing, add it to If the browser doesn't open automatically, copy the OAuth URL shown in the terminal and paste it into your browser manually. -If you're running OpenCode in a headless environment (SSH, remote container) or the OAuth flow still fails, use token authentication instead. Set it before starting OpenCode: +If you're running OpenCode in a headless environment (SSH, remote container) or the OAuth flow still fails, use token authentication instead. Set it before starting OpenCode: ```bash export APIFY_TOKEN= diff --git a/sources/platform/integrations/agents/qoder/qwen.md b/sources/platform/integrations/agents/qoder/qwen.md index 6140605271..3ca6984929 100644 --- a/sources/platform/integrations/agents/qoder/qwen.md +++ b/sources/platform/integrations/agents/qoder/qwen.md @@ -185,7 +185,7 @@ If the sign-in page doesn't open or the server stays disconnected: - **Qwen Code:** copy the authorization URL from the terminal and open it manually. If sign-in still fails, add an `Authorization: Bearer ` header to the `apify` server in `~/.qwen/settings.json` under `mcpServers` - see the [Streamable HTTP configuration](/mcp#streamable-http-with-oauth-recommended) for the shape. - **QwenWork:** remove the connector and add it again. If OAuth still won't complete, re-add it with an `Authorization` header set to `Bearer `. -For the `Authorization` header, use an API token. Setting `APIFY_TOKEN` in your shell doesn't authenticate the MCP server; it only covers the Apify CLI and `apify-client` used by the Actor development, actorization, and SDK integration skills, so run `apify login` once for those. +For the `Authorization` header, use an API token. Setting `APIFY_TOKEN` in your shell doesn't authenticate the MCP server; it only covers the Apify CLI and `apify-client` used by the Actor development, actorization, and SDK integration skills, so run `apify login` once for those. ## Limitations diff --git a/sources/platform/integrations/ai/agno.md b/sources/platform/integrations/ai/agno.md index 9c4db6661f..31405365cf 100644 --- a/sources/platform/integrations/ai/agno.md +++ b/sources/platform/integrations/ai/agno.md @@ -18,7 +18,7 @@ This guide shows how to integrate Apify Actors with Agno to empower your AI agen ### Prerequisites -- _Apify API token_: +- _Apify API token_: - _OpenAI API key_: Get your API key from the [OpenAI platform](https://platform.openai.com/account/api-keys). :::tip Alternative LLM providers diff --git a/sources/platform/integrations/ai/crewai.md b/sources/platform/integrations/ai/crewai.md index fbdda706de..f75694c934 100644 --- a/sources/platform/integrations/ai/crewai.md +++ b/sources/platform/integrations/ai/crewai.md @@ -18,7 +18,7 @@ This guide demonstrates how to integrate Apify Actors with CrewAI by building a ### Prerequisites -- **Apify API token**: +- **Apify API token**: - **OpenAI API key**: To power the agents in CrewAI, you need an OpenAI API key. Get one from the [OpenAI platform](https://platform.openai.com/account/api-keys). - **Python packages**: Install the following Python packages: diff --git a/sources/platform/integrations/ai/flowise.md b/sources/platform/integrations/ai/flowise.md index 7bbe5ecff0..cdc5db15e7 100644 --- a/sources/platform/integrations/ai/flowise.md +++ b/sources/platform/integrations/ai/flowise.md @@ -56,7 +56,7 @@ Now you need to configure the crawler. You can find more information about at [W In the configuration, provide your Apify API token. - + ![Apify API token screen](../images/flowise-apify-api.png) diff --git a/sources/platform/integrations/ai/google-adk.md b/sources/platform/integrations/ai/google-adk.md index cb76aa3353..646245883b 100644 --- a/sources/platform/integrations/ai/google-adk.md +++ b/sources/platform/integrations/ai/google-adk.md @@ -18,7 +18,7 @@ Apify is a marketplace of web scraping and automation tools, AI agents, and MCP ### Prerequisites -- _Apify API token_: +- _Apify API token_: - _Python packages_: Install the following Python packages: ```bash diff --git a/sources/platform/integrations/ai/langchain/langgraph.md b/sources/platform/integrations/ai/langchain/langgraph.md index f02c9d58e5..9cd7121fcc 100644 --- a/sources/platform/integrations/ai/langchain/langgraph.md +++ b/sources/platform/integrations/ai/langchain/langgraph.md @@ -49,7 +49,7 @@ This guide shows how to use Apify Actors with LangGraph by building a ReAct agen ### Prerequisites -- **Apify API token**: +- **Apify API token**: - **OpenAI API key**: To work with agents in LangGraph, you need an OpenAI API key. If you don't have one, you can get it from the [OpenAI platform](https://platform.openai.com/account/api-keys). diff --git a/sources/platform/integrations/ai/langflow.md b/sources/platform/integrations/ai/langflow.md index 7c32ddac62..a45a2f06ab 100644 --- a/sources/platform/integrations/ai/langflow.md +++ b/sources/platform/integrations/ai/langflow.md @@ -21,7 +21,7 @@ This guide will demonstrate two different ways to use Apify Actors with Langflow ### Prerequisites -- **Apify API token**: +- **Apify API token**: - **OpenAI API key**: To work with agents in Langflow, you need an OpenAI API key. If you don't have one, you can get it from the [OpenAI platform](https://platform.openai.com/account/api-keys). diff --git a/sources/platform/integrations/ai/mastra.md b/sources/platform/integrations/ai/mastra.md index 82c56ae1dc..7b1bae64fa 100644 --- a/sources/platform/integrations/ai/mastra.md +++ b/sources/platform/integrations/ai/mastra.md @@ -22,7 +22,7 @@ This guide demonstrates how to integrate Apify Actors with Mastra by building an ### Prerequisites -- _Apify API token_: +- _Apify API token_: - _LLM provider API key_: To power the agents, you need an LLM provider API key. For example, get one from the [OpenAI](https://platform.openai.com/account/api-keys) or [Anthropic](https://platform.claude.com/settings/keys). - _Node.js_: Ensure you have Node.js installed. - _Packages_: Install the following packages: diff --git a/sources/platform/integrations/ai/openai/openai-agents.md b/sources/platform/integrations/ai/openai/openai-agents.md index 95c513e225..5437c710a1 100644 --- a/sources/platform/integrations/ai/openai/openai-agents.md +++ b/sources/platform/integrations/ai/openai/openai-agents.md @@ -20,7 +20,7 @@ For more details about the OpenAI Agents SDK, refer to the [official documentati Before integrating Apify with OpenAI Agents SDK, you'll need: - _An Apify account_ - If you don't have an Apify account already, you can [sign up](https://console.apify.com/sign-up) -- _Apify API token_ - This token authorizes the Apify MCP server to run Actors on your behalf. +- _Apify API token_ - This token authorizes the Apify MCP server to run Actors on your behalf. - _OpenAI API key_ - Get your API key from the [OpenAI platform](https://platform.openai.com/account/api-keys). You need this to use OpenAI Agents SDK. - _Python packages_ - Install the required packages: diff --git a/sources/platform/integrations/ai/upsonic.md b/sources/platform/integrations/ai/upsonic.md index 813f3d2418..efc9be722e 100644 --- a/sources/platform/integrations/ai/upsonic.md +++ b/sources/platform/integrations/ai/upsonic.md @@ -29,7 +29,7 @@ This guide shows how to integrate Apify Actors with Upsonic using the built-in ` ### Prerequisites -- Apify API token: +- Apify API token: - Anthropic API key (or another LLM provider): Get one from the [Anthropic Console](https://console.anthropic.com). - Python environment: Python 3.9 or later. - Required packages: Install the following dependencies: diff --git a/sources/platform/integrations/ai/vercel-ai-sdk.md b/sources/platform/integrations/ai/vercel-ai-sdk.md index 004bd35fb7..c676bd2be7 100644 --- a/sources/platform/integrations/ai/vercel-ai-sdk.md +++ b/sources/platform/integrations/ai/vercel-ai-sdk.md @@ -18,7 +18,7 @@ Apify is a marketplace of ready-to-use web scraping and automation tools, AI age ### Prerequisites -- _Apify API token_: Set it as the `APIFY_TOKEN` environment variable. +- _Apify API token_: Set it as the `APIFY_TOKEN` environment variable. - _Node.js packages_: Install the following Node.js packages: ```bash diff --git a/sources/platform/integrations/data-and-storage/airbyte.md b/sources/platform/integrations/data-and-storage/airbyte.md index 8940030c6f..c66ca4583d 100644 --- a/sources/platform/integrations/data-and-storage/airbyte.md +++ b/sources/platform/integrations/data-and-storage/airbyte.md @@ -24,7 +24,7 @@ This guide shows you how to set up an Apify dataset as a source in Airbyte and c The Apify Dataset source reads items from a single dataset, identified by its ID. Each Actor run writes to a new default dataset. To keep syncing the results of repeated runs, have your Actor write to a [named dataset](/storage#named-and-unnamed-storages) and use its ID. 1. In [Apify Console](https://console.apify.com), open **Storage > Datasets**, select your dataset, and copy its ID. -1. +1. 1. In Airbyte, open the **Sources** tab and select **Apify Dataset**. 1. Enter the **Dataset ID** and **API token** you copied, and save the source. diff --git a/sources/platform/integrations/data-and-storage/keboola.md b/sources/platform/integrations/data-and-storage/keboola.md index 8a6a817c8f..f66dc6618a 100644 --- a/sources/platform/integrations/data-and-storage/keboola.md +++ b/sources/platform/integrations/data-and-storage/keboola.md @@ -57,7 +57,7 @@ In the next step, you can choose the action you want to perform: After selecting the action, you will need to provide your Apify API token in the provided form. - + ![Keboola API authentication](../images/keboola/keboola-setup-api-token.png) diff --git a/sources/platform/integrations/programming/github.md b/sources/platform/integrations/programming/github.md index 34459bd525..1bcee9cfd0 100644 --- a/sources/platform/integrations/programming/github.md +++ b/sources/platform/integrations/programming/github.md @@ -81,7 +81,7 @@ In such situation, to build your Actor automatically on every push, manually add https://api.apify.com/v2/actors/YOUR-ACTOR-NAME/builds?token=&version=0.0&tag=latest&waitForFinish=60 ``` -1. Replace the `` placeholder in the URL with an API token. +1. Replace the `` placeholder in the URL with an API token. 1. In your GitHub repository, go to **Settings > Webhooks > Add webhook**. 1. Paste the endpoint URL into **Payload URL** and set **Content type** to `application/json`. 1. Save your changes. diff --git a/sources/platform/integrations/workflows-and-notifications/activepieces.md b/sources/platform/integrations/workflows-and-notifications/activepieces.md index a3293d0910..dbe02e9186 100644 --- a/sources/platform/integrations/workflows-and-notifications/activepieces.md +++ b/sources/platform/integrations/workflows-and-notifications/activepieces.md @@ -41,7 +41,7 @@ To connect your Apify account to Activepieces: 1. In Activepieces, open the **Connections** section. 1. Click **+ New Connection**. 1. Search for and select the Apify piece. -1. Enter your Apify API token in the **API Key** field. +1. Enter your Apify API token in the **API Key** field. 1. Save the connection. ![Apify API key setup](../images/activepieces/api-token.png) diff --git a/sources/platform/integrations/workflows-and-notifications/dify.md b/sources/platform/integrations/workflows-and-notifications/dify.md index 2d13e0d51e..09979fa73d 100644 --- a/sources/platform/integrations/workflows-and-notifications/dify.md +++ b/sources/platform/integrations/workflows-and-notifications/dify.md @@ -33,7 +33,7 @@ To connect your Apify account, configure the plugin using your Apify API token o ### API key 1. Open the plugin window and select **Add API Key**. -1. In the pop-up menu, paste your Apify API token. +1. In the pop-up menu, paste your Apify API token. 1. Select **Save**. ![Apify Auth in Dify](../images/dify-connection-popup.png) diff --git a/sources/platform/integrations/workflows-and-notifications/gumloop/index.md b/sources/platform/integrations/workflows-and-notifications/gumloop/index.md index 8b8c43fae2..98d6a02629 100644 --- a/sources/platform/integrations/workflows-and-notifications/gumloop/index.md +++ b/sources/platform/integrations/workflows-and-notifications/gumloop/index.md @@ -54,7 +54,7 @@ To use the Apify integration in Gumloop, you need an Apify account, a Gumloop ac 1. _Get your Apify API token_ - + 1. _Add Apify credentials to Gumloop_ diff --git a/sources/platform/integrations/workflows-and-notifications/make/index.md b/sources/platform/integrations/workflows-and-notifications/make/index.md index 23d10b2746..14a86b5cf4 100644 --- a/sources/platform/integrations/workflows-and-notifications/make/index.md +++ b/sources/platform/integrations/workflows-and-notifications/make/index.md @@ -32,7 +32,7 @@ Next, select one of the available options under Triggers, Actions and Searches, In the Connection configuration window, you'll authorize the connection between Make and Apify. The recommended method is to use an OAuth connection. Alternatively, you can choose to connect using Apify API token: -1. You will need to provide your Apify API token in the designated field. +1. You will need to provide your Apify API token in the designated field. ![API token](../../images/apify-token.png) diff --git a/sources/platform/integrations/workflows-and-notifications/n8n/index.md b/sources/platform/integrations/workflows-and-notifications/n8n/index.md index e7ac4fb97e..54d166b243 100644 --- a/sources/platform/integrations/workflows-and-notifications/n8n/index.md +++ b/sources/platform/integrations/workflows-and-notifications/n8n/index.md @@ -60,7 +60,7 @@ The Apify node offers two authentication methods to securely connect to your Api 1. In the n8n Editor UI, click on **Create Credential**. 1. Search for Apify API and click **Continue**. -1. Enter your Apify API token. +1. Enter your Apify API token. 1. Click **Save**. ![Apify Auth](../../images/n8n-api-auth.webp) diff --git a/sources/platform/integrations/workflows-and-notifications/pipedream.md b/sources/platform/integrations/workflows-and-notifications/pipedream.md index f661adf600..9defecde46 100644 --- a/sources/platform/integrations/workflows-and-notifications/pipedream.md +++ b/sources/platform/integrations/workflows-and-notifications/pipedream.md @@ -26,7 +26,7 @@ Before you begin, make sure you have: ![Selecting the Apify app in Pipedream](../images/pipedream-select-app.png) - - **Apify** - Authenticate with a token. + - **Apify** - Authenticate with a token. - **Apify (OAuth)** - Authorize access to your Apify account via OAuth. 1. Follow the prompts to authenticate your account. diff --git a/sources/platform/integrations/workflows-and-notifications/telegram.md b/sources/platform/integrations/workflows-and-notifications/telegram.md index b2d1138f90..8c4e726322 100644 --- a/sources/platform/integrations/workflows-and-notifications/telegram.md +++ b/sources/platform/integrations/workflows-and-notifications/telegram.md @@ -65,7 +65,7 @@ The connection configuration options open in a new tab in your browser or in a m In connection configuration, you need to provide your Apify API token. - + Paste the token into the configuration form and continue with the **Yes, Continue to Apify** button. diff --git a/sources/platform/integrations/workflows-and-notifications/viasocket.md b/sources/platform/integrations/workflows-and-notifications/viasocket.md index 4c6760ae24..301ca6497d 100644 --- a/sources/platform/integrations/workflows-and-notifications/viasocket.md +++ b/sources/platform/integrations/workflows-and-notifications/viasocket.md @@ -14,7 +14,7 @@ import CreateApiToken from '@site/sources/\_partials/\_create-api-token.mdx'; ## Step 1: Generate an Apify API token - + :::caution Token security Never share your API token publicly or commit it to version control. diff --git a/sources/platform/integrations/workflows-and-notifications/workato.md b/sources/platform/integrations/workflows-and-notifications/workato.md index 7d31fb6aab..f1af3602d1 100644 --- a/sources/platform/integrations/workflows-and-notifications/workato.md +++ b/sources/platform/integrations/workflows-and-notifications/workato.md @@ -48,7 +48,7 @@ Before using the Apify connector in recipes, create a connection inside a Workat ![Screenshot showing how to create connection](../images/workato/create-connection.webp) 1. Search for **Apify** and choose the Apify connector. ![Screenshot showing how to search for the Apify connector in Workato](../images/workato/create-connection-find-connector.webp) -1. In the connection dialog, enter your **API Token**. +1. In the connection dialog, enter your **API Token**. ![Screenshot of the Workato API Key authentication form](../images/workato/create-connection-api-key.webp) 1. Click **Connect**. Workato tests the connection by making an authenticated call to verify your credentials. ![Screenshot showing successful API Key authentication in Workato](../images/workato/create-connection-api-success.webp) diff --git a/src/components/ApiToken.jsx b/src/components/ApiToken.jsx index 4fa75d9416..ada466357f 100644 --- a/src/components/ApiToken.jsx +++ b/src/components/ApiToken.jsx @@ -7,24 +7,24 @@ import Link from '@docusaurus/Link'; // Opens the create token form in Apify Console. const CREATE_TOKEN_URL = 'https://console.apify.com/settings/integrations?createApiToken=true'; -// `description` prefills the token description in the form, e.g. "Make.com". -const createTokenUrl = (description) => - description ? `${CREATE_TOKEN_URL}&for=${encodeURIComponent(description)}` : CREATE_TOKEN_URL; +// `integration` names what the token is for, e.g. "Make.com". Console prefills the form with it. +const createTokenUrl = (integration) => + integration ? `${CREATE_TOKEN_URL}&for=${encodeURIComponent(integration)}` : CREATE_TOKEN_URL; // Link to the create token form with custom text: "create one in Apify Console" -export const CreateTokenLink = ({ description, children }) => {children}; +export const CreateTokenLink = ({ integration, children }) => {children}; -// Prerequisite bullets: "- _Apify API token_ - " -export const CreateApiTokenLink = ({ description }) => ( +// Prerequisite bullets: "- _Apify API token_ - " +export const CreateApiTokenLink = ({ integration }) => ( <> - Create an API token in Apify Console. + Create an API token in Apify Console. ); // Tail of a step that asks for the token: "1. Enter your token in the field. " -export const GetApiTokenHint = ({ description }) => ( +export const GetApiTokenHint = ({ integration }) => ( <> - To get one, create an API token in Apify Console and + To get one, create an API token in Apify Console and copy it. );