Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ Actor detail https://console.apify.com/actors/Yk1bieximsduYDydP
Success: Actor was deployed to Apify cloud and built there.
```

The URLs tell us that our Actor's ID is `Yk1bieximsduYDydP`. With this `actorId`, and our `token`, which is retrievable through **Settings > Integrations** in Apify Console, we can construct a link which will call the Actor:
The URLs tell us that our Actor's ID is `Yk1bieximsduYDydP`. With this `actorId`, and our `token`, which is retrievable through **Settings > API & Integrations** in Apify Console, we can construct a link which will call the Actor:

```text
https://api.apify.com/v2/acts/Yk1bieximsduYDydP/runs?token=YOUR_TOKEN_HERE
Expand Down
2 changes: 1 addition & 1 deletion sources/academy/platform/getting_started/apify_client.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 though, we must create a new instance of the `ApifyClient` class and pass it our API token from the [**Integrations** page](https://console.apify.com/account?tab=integrations&asrc=developers_portal) on Apify Console:
Before we can use the client though, we must create a new instance of the `ApifyClient` class and pass it our API token from the [**API & Integrations** page](https://console.apify.com/settings/integrations?asrc=developers_portal) on Apify Console:

<Tabs groupId="main">
<TabItem value="Node.js" label="Node.js">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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](/platform/integrations), which you can find on the **Integrations** page in [Apify Console](https://console.apify.com/account?tab=integrations) (do not share it with anyone!).
- Your [API token](/platform/integrations), which you can find on the **API & Integrations** page in [Apify Console](https://console.apify.com/settings/integrations) (do not share it with anyone!).

- Possibly an input, which is passed in JSON format as the request's **body**.

Expand Down Expand Up @@ -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
// (find it at https://console.apify.com/account#/integrations)
// (find it at https://console.apify.com/settings/integrations)
const myToken = '<YOUR_APIFY_TOKEN>';

// Start apify/google-search-scraper Actor
Expand Down
2 changes: 1 addition & 1 deletion sources/academy/tutorials/api/using_apify_from_php.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Apify does not have an official PHP client (yet), so we are going to use [guzzle

## Before you start

Make sure you have an Apify account and API token. You will find the token in the [Integrations](https://console.apify.com/account#/integrations) section in Apify Console.
Make sure you have an Apify account and API token. You will find the token in the [API & Integrations](https://console.apify.com/settings/integrations) section in Apify Console.

If you don't already have guzzle installed in your project (or just want to try out the code examples), run `composer require guzzlehttp/guzzle` to install it in the current directory.

Expand Down
2 changes: 1 addition & 1 deletion sources/api/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ You must authenticate all API requests presented on this page. You can authentic
Authorization: Bearer YOUR_API_TOKEN
```

You can find your API token in Apify Console under **[Settings > Integrations](https://console.apify.com/settings/integrations)**.
You can find your API token in Apify Console under **[Settings > API & Integrations](https://console.apify.com/settings/integrations)**.

### Verify your account

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,21 @@ import TabItem from '@theme/TabItem';

## What you'll learn

This guide walks you through the full lifecycle of an Actor. You'll start by creating and running it locally with the Apify CLI, then learn to configure its input and data storage. Finally, you will deploy the Actor to the Apify platform, making it ready to run in the cloud.
This guide walks you through the full lifecycle of an Actor using the web IDE in Apify Console. You'll create an Actor from a code template, build it, configure its input, and run it in the cloud.

### Prerequisites

- An Apify account. [Sign up for a free account](https://console.apify.com/sign-up) on the Apify website.

### Step 1: Create your Actor

Log in to [Apify Console](https://console.apify.com), navigate to [**My Actors**](https://console.apify.com/actors/development/my-actors), then click the **Develop new** button.
Log in to [Apify Console](https://console.apify.com), navigate to [**My Actors**](https://console.apify.com/actors/development/my-actors), then click the **Develop new** button. You can also click the **Create** button on the Dashboard and select **Create Actor**.

![Create Actor](./images/create-actor.png)

You'll see Actor development templates for `JavaScript`, `TypeScript`, and `Python`.
You'll see options to link a Git repository, select a code template, or push code with the Apify CLI.

These templates provide boilerplate code and a preconfigured environment. Choose the template that best suits your needs. For the following demo, we'll proceed with **Crawlee + Puppeteer + Chrome**.
Under **Select a code template**, you'll find quick-start templates for TypeScript, Python, and JavaScript. Click **Browse all templates** to see the full list. Choose the template that best suits your needs. For the following demo, we'll proceed with a **Crawlee + Cheerio** template.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Worth adding which version of a Crawlee + Cheerio template we're using. TypeScript or JavaScript? 🤔


:::info Explore Actor templates

Expand Down Expand Up @@ -65,7 +65,7 @@ The UI includes four tabs:
- **Code**
- **Last build**
- **Input**
- **Last Run**
- **Last run**

This represents the Actor creation flow, where you first build the Actor from the source code. Once the build is successful, you can provide input parameters and initiate an Actor run.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions sources/platform/actors/running/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,11 @@ For this tutorial, let's choose [Website Content Crawler](https://console.apify.

### 2. Configure and run your Actor

Once you select the Actor, click **Use Actor**.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This button is used for the new UI; beware.

Once you select the Actor, you will be taken to the Actor's detail page.

In the **Input** tab, you can customize your Actor's behavior. Website Content Crawler is pre-configured to run without extra input, so you don't need to change anything.

To run the Actor, click **Save & Start**.
To run the Actor, click **Start**.

![Actor input](./images/apify-input.png)

Expand Down
3 changes: 2 additions & 1 deletion sources/platform/actors/running/store.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ All Actors in [Apify Store](https://apify.com/store) fall into one of the four p

1. [**Pay per event**](#pay-per-event) - you pay for specific events the Actor creator defines, such as generating a single result or starting the Actor. Most Actors include platform usage in the price, but some may charge it separately - check the Actor's pricing for details.
1. [**Pay per result**](#pay-per-result) - you do not pay for platform usage the Actor generates and instead just pay for the results it produces.
1. [**Pay per usage**](#pay-per-usage) - you can run the Actor and you pay for the platform usage the Actor generates.
1. [**Pay per usage**](#pay-per-usage) - you only pay for the platform resources (compute units, data transfer, etc.) the
Actor consumes. There are no additional charges from the Actor developer.
1. [**Rental**](#rental-actors) - to continue using the Actor after the trial period, you must rent the Actor from the developer and pay a flat monthly fee in addition to the costs associated with the platform usage that the Actor generates.

:::note Post-run storage costs
Expand Down
2 changes: 1 addition & 1 deletion sources/platform/actors/running/tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ You can find all your tasks in the [Apify Console](https://console.apify.com/act

## Create

To create a task, open any Actor from [Apify Store](https://console.apify.com/store) or your list of [Actors](https://console.apify.com/actors) in Apify Console. At the top-right section of the page, click the **Create task** button.
To create a task, open any Actor from [Apify Store](https://console.apify.com/store) or your list of [Actors](https://console.apify.com/actors) in Apify Console. At the top-right section of the page, click the **Save as a new task** button.

![Create a new Apify task](./images/tasks/tasks-create-task.png)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@TC-MO This screenshot deserves a proper refresh.


Expand Down
6 changes: 3 additions & 3 deletions sources/platform/collaboration/general-resource-access.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Some resources, like storages, Actor runs or Actor builds, can be shared simply

Thanks to the hard-to-guess, unique IDs, it’s also secure enough for most use cases. However, it doesn't offer features like access revocation and in some cases, you may want to have more direct control over data access and require users to have explicit permissions to your resources.

**General resource access** is an account setting that defines the default access policy at the account level. You can find General resource access in Apify Console under **Settings → Security & Privacy**. The two following options are supported:
**General resource access** is an account setting that defines the default access policy at the account level. You can find General resource access in Apify Console under **Settings → Login & Privacy** (or **Settings → Security & Privacy** for organization accounts). The two following options are supported:

- **Anyone with ID can read (default)**: Selected resources can be accessed using just their unique resource ID. This means if you share the resource ID with someone, they would be able to view it without providing an API token or viewing the resource by visiting the Console URL.
- **Restricted**: With this setting, only signed-in users with an explicit access to the resources can access them. To access restricted resources via API, a valid token needs to be provided.
Expand Down Expand Up @@ -79,7 +79,7 @@ When you share an Actor with a collaborator, you can choose to share read-only a

If you’re using a public Actor from Apify Store, you can choose to automatically share your runs of that Actor with its creator. This helps developers monitor usage and troubleshoot issues more effectively.

- This setting is opt-in and can be enabled under **Account Settings → Privacy**
- This setting is opt-in and can be enabled under **Settings → Login & Privacy** in the **Share run data with developers** section
- When enabled, your runs of public Actors are automatically visible to the Actor’s creator
- Shared runs include logs, input, and output storages (dataset, key-value store, request queue)

Expand Down Expand Up @@ -171,7 +171,7 @@ You can create pre-signed URLs either through Apify Console or programmatically

To generate a pre-signed link, you can use the **Export** button in Console.

:::note
:::note Pre-signed URL signatures

The link will include a signature _only if the general resource access is set to Restricted_. For unrestricted datasets, the link will work without a signature.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified sources/platform/collaboration/images/organizations/members.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified sources/platform/collaboration/images/organizations/roles.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The resources you can access and account details you can edit will depend on you

### Manage your organizations

You can view and manage the organizations you are a member of from the **Organizations** tab on your [account page](https://console.apify.com/account#/myorganization).
You can view and manage the organizations you are a member of from the **Organizations** tab on your [account page](https://console.apify.com/settings/organizations).

If you want to leave an organization you own, you must first transfer ownership to someone else.

Expand All @@ -40,7 +40,7 @@ The organization, its Actors, and its integrations will keep running as they are

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

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

![Integration tokens](../images/organizations/integrations.png)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@TC-MO This screenshot deserves a proper refresh.


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The organization account is available on all plans. [Visit the pricing page](htt

## Create a new organization

You can create a new organization by clicking the **Create new organization** button under the **Organizations** tab in your [account](https://console.apify.com/account#/myorganizations). If you want the organization to have a separate email address (used for notifications), enter it here. Otherwise, leave the **email** field empty and the owner's email will be used for notifications.
You can create a new organization by clicking the **Create new organization** button under the **Organizations** tab in your [account](https://console.apify.com/settings/organizations). If you want the organization to have a separate email address (used for notifications), enter it here. Otherwise, leave the **email** field empty and the owner's email will be used for notifications.

![Create a new organization](../images/organizations/create-new-org.png)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@TC-MO This screenshot deserves a proper refresh.


Expand All @@ -40,7 +40,7 @@ Before converting your personal account into an organization, make sure it has a

An organization can't be a member of other organizations. If you want to convert your account to one, you'll first need to **leave all the organizations you are a part of**.

Then, under the **Organizations** [tab](https://console.apify.com/account#/myorganizations), click the **Convert this user account to an organization** button.
Then, under the **Organizations** [tab](https://console.apify.com/settings/organizations), click the **Convert this user account to an organization** button.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@TC-MO It might be worth noting that you can't convert your account to an organization if you're already part of one.


![Convert your account to an organization](../images/organizations/convert-to-organization.png)

Expand Down
2 changes: 1 addition & 1 deletion sources/platform/console/billing.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Below the bar chart, there is a table titled **Usage by Actors**. This table pre

## Subscription

The **Subscriptions** tab offers a central location to manage various aspects of your subscription plan. Here, you can access details about your current plan and explore options to upgrade to a different one.
The **Subscription** tab offers a central location to manage various aspects of your subscription plan. Here, you can access details about your current plan and explore options to upgrade to a different one.

:::info Unused credits

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
29 changes: 18 additions & 11 deletions sources/platform/console/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ If you did not receive the email, you can visit the [sign-in page](https://conso

### Google or GitHub

If you do not want to create a new password for Apify Console, you can also use your Google or GitHub account to sign up. To do that, click the **Sign up with Google** or **Sign up with GitHub** buttons. You will proceed to the corresponding authentication page, where you must sign in and authorize Apify to access your account. Then, when you come back to Apify Console, we will create your account.
If you do not want to create a new password for Apify Console, you can also use your Google or GitHub account to sign up. To do that, click the **Continue with Google** or **Continue with GitHub** buttons. You will proceed to the corresponding authentication page, where you must sign in and authorize Apify to access your account. Then, when you come back to Apify Console, we will create your account.

If you used Google to sign up, there is no verification step after this, and you can start using Apify Console right away.
On the other hand, if you used GitHub to create your account and your GitHub account does not have a verified email, we will ask you to verify your email address before you can start using Apify Console. The process works the same as the process for email and password authentication.
Expand Down Expand Up @@ -66,22 +66,28 @@ After you click on the link (or copy it to your browser), you will proceed to a

![Apify Console reset password page](./images/console-reset-password-page.png)

## Homepage overview
## Dashboard overview

![apify-console-homepage](./images/apify-console-homepage.png)
![apify-console-homepage](./images/apify-console-dashboard.png)

The Apify Console homepage provides an overview of your account setup. The header displays your account name and current plan level. The homepage features several sections:
The Apify Console Dashboard provides an overview of your account. The header displays your account name and current plan level. The Dashboard features several sections:

- **Recently Viewed**: This section displays Actors you have recently accessed. If you haven't used any Actors yet, you will see suggestions instead.
- **Recently viewed**: This section displays Actors you have recently accessed. If you haven't used any Actors yet, you will see suggestions instead.

- **Suggested Actors for You**: Based on your and other users' recent activities, this section recommends Actors that might interest you.
- **Suggested Actors for you**: Based on your and other users' recent activities, this section recommends Actors that might interest you.

- **Actor Runs**: This section is divided into two tabs:
- **Actor runs**: This section is divided into two tabs:
- **Recent**: View your latest Actor runs.
- **Scheduled**: Check your upcoming scheduled runs and tasks.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@TC-MO I would also add a mention about the "Create" button.


Use the side menu to navigate other parts of Apify Console easily.

The **Create** dropdown in the top navigation offers three options:

- **Create Actor**
- **Create schedule**
- **Create a new token**

<!-- markdownlint-disable-next-line -->
#### Keyboard shortcuts

Expand All @@ -93,7 +99,7 @@ You can also navigate Apify Console via keyboard shortcuts.
| Shortcut | Tab |
| :--- | :--- |
| Show shortcuts | Shift? |
| Home | GH |
| Dashboard | GH |
| Store | GO |
| Actors | GA |
| Development | GD |
Expand All @@ -111,13 +117,14 @@ You can also navigate Apify Console via keyboard shortcuts.
| Tab name | Description |
| :--- | :--- |
| [Apify Store](/platform/console/store) | Search for Actors that suit your web-scraping needs. |
| [Dashboard](/platform/console) | Overview of your account with recently viewed Actors, suggestions, and recent runs. |
| [Actors](/platform/actors) | View recent & bookmarked Actors. |
| [Runs](/platform/actors/running/runs-and-builds) | View your recent runs. |
| [Saved tasks](/platform/actors/running/tasks) | View your saved tasks. |
| [Schedules](/platform/schedules) | Schedule Actor runs & tasks to run at specified time. |
| [Integrations](/platform/integrations) | View your integrations. |
| [Schedules](/platform/schedules) | Schedule Actor runs & tasks to run at specified time. |
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mtrunkat Not sure why this moved lower?

| [Development](/platform/actors/development) | &bull; My Actors - See Actors developed by you. <br/> &bull; Insights - see analytics for your Actors. <br/> &bull; Messaging - check on issues reported in your Actors or send emails to users of your Actors. |
| [Proxy](/platform/proxy) | View your proxy usage & credentials |
| [Proxy](/platform/proxy) | View your proxy usage & credentials. |
| [Storage](/platform/storage) | View stored results of your runs in various data formats. |
| [Billing](/platform/console/billing) | Billing information, statistics and invoices. |
| [Billing](/platform/console/billing) | Billing information, statistics, and invoices. |
| [Settings](/platform/console/settings) | Settings of your account. |
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@TC-MO I would also add a mention about the "Create" button.

Loading
Loading