# Quickstart
URL: /integrations/n8n

Best for building complex, multi-step no-code automations. Perfect for users who want powerful automation capabilities with full control over their workflows.

***

title: "Quickstart"
description: "Best for building complex, multi-step no-code automations. Perfect for users who want powerful automation capabilities with full control over their workflows."
icon: Rocket
------------

import {SiDigitalocean, SiHostinger, SiN8n} from "@icons-pack/react-simple-icons";
import {BoxIcon, ServerIcon, TerminalIcon} from "lucide-react";
import { Step, Steps } from 'fumadocs-ui/components/steps';
import {Card, Cards} from "fumadocs-ui/components/card";
import { Accordion, Accordions } from 'fumadocs-ui/components/accordion';

import {ZapIcon} from "lucide-react";

<Callout title="This integration supports every OnlyFans API endpoint!" type="success" icon={<ZapIcon size={18} className="text-(--callout-color)"/>}>
  Our n8n integration is our most actively maintained integration, and it supports every single endpoint in our API.
</Callout>

<Callout title="Only available on self-hosted instances" type="warn">
  Currently, our n8n integration is only available for self-hosted instances of n8n. We are actively working on making it available for n8n cloud users as well.
</Callout>

## Prerequisites

To get started, you must have:

<Cards>
  <Card icon={<TerminalIcon className="text-fd-primary" />} href="https://app.onlyfansapi.com" title="An OnlyFans API account">
    If you don't have one yet, registering takes just a few seconds.

    <a className="flex flex-row items-center gap-1 w-fit">
      » Create a free account
    </a>
  </Card>

  <Card icon={<SiN8n color="default" />} title="A self-hosted n8n instance">
    You can either use your own infrastructure, or a one-click provider. Some popular options are:

    <a className="flex flex-row items-center gap-1 w-fit" href="https://www.hostinger.com/self-hosted-n8n" target="_blank">
      <SiHostinger size={16} color="default" />

      <span>Hostinger</span>
    </a>

    <a className="flex flex-row items-center gap-1 mt-2 w-fit" href="https://marketplace.digitalocean.com/apps/n8n" target="_blank">
      <SiDigitalocean size={16} color="default" />

      <span>DigitalOcean</span>
    </a>

    <a className="flex flex-row items-center gap-1 mt-2 w-fit" href="https://docs.n8n.io/hosting" target="_blank">
      <ServerIcon size={16} className="text-fd-primary" />

      <span>Self-hosted</span>
    </a>
  </Card>
</Cards>

## Getting started

There are two ways to install our community node, through the n8n interface, or through the command line.

<Accordions type="single" orientation="vertical">
  <Accordion title="Using the n8n interface (recommended)">
    Use this method to easily install our community node from the npm registry.

    <Steps>
      <Step>
        Log in to your n8n instance.
      </Step>

      <Step>
        Click on your profile image in the bottom-left corner, and then press on "Settings".
        ![Home to settings](/images/n8n/home-to-settings.png)
      </Step>

      <Step>
        <span className="flex flex-row items-center gap-1">
          <span>
            Click on **"**
          </span>

          <BoxIcon className="-ml-1" />

          <span>
            **Community nodes"** and then **"Install a community node"**.
          </span>
        </span>

        ![Install community node](/images/n8n/install-community-node.png)
      </Step>

      <Step>
        In the **"npm Package Name"** field, enter `n8n-nodes-onlyfansapi`, tick the checkbox, and press "Install".
        ![Install community node modal](/images/n8n/install-community-node-modal.png)
      </Step>
    </Steps>
  </Accordion>

  <Accordion title="Manually from the command line">
    Use this method to install our community node from npm if your n8n instance doesn't support installation through the in-app interface.

    <Steps>
      <Step>
        Access your Docker shell:

        ```bash
        docker exec -it n8n sh
        ```
      </Step>

      <Step>
        Create the `~/.n8n/nodes` directory if it doesn't already exist, and navigate into it:

        ```bash
        mkdir ~/.n8n/nodes
        cd ~/.n8n/nodes
        ```
      </Step>

      <Step>
        Install the OnlyFans API node with your package manager:

        ```npm
        npm i @onlyfansapi/n8n-nodes-onlyfansapi -D
        ```
      </Step>

      <Step>
        Finally, restart n8n.
      </Step>
    </Steps>
  </Accordion>
</Accordions>

## Upgrading the OnlyFans API node

We frequently release updates to our n8n community node, adding new features and fixing bugs. To upgrade to the latest version, follow the instructions below:

<Accordions type="single" orientation="vertical">
  <Accordion title="Using the n8n interface">
    <Steps>
      <Step>
        Access the **"Community nodes"** page through the n8n settings
      </Step>

      <Step>
        Find the OnlyFans API node in the list of installed nodes, and click on the **"Update"** button next to it
      </Step>

      <Step>
        Follow the prompts to complete the update process.
      </Step>
    </Steps>
  </Accordion>

  <Accordion title="Manually from the command line">
    <Steps>
      <Step>
        Access your Docker shell:

        ```bash
        docker exec -it n8n sh
        ```
      </Step>

      <Step>
        Update our node through your package manager:

        ```bash
        npm update @onlyfansapi/n8n-nodes-onlyfansapi
        ```
      </Step>
    </Steps>
  </Accordion>
</Accordions>

## Connecting your OnlyFans API account to n8n

<Steps>
  <Step>
    Head to your n8n instance's homepage, and click on **"Create Credential"** in the **"Create Workflow"** dropdown.
    ![Add credentials](/images/n8n/add-credentials.png)
  </Step>

  <Step>
    Select **"OnlyFans API"** from the list of available credential types, and click **"Continue"**.
    ![Add credential modal](/images/n8n/add-credential-modal.png)
  </Step>

  <Step>
    ### Create a new API key from the OnlyFans API Console \[!toc]

    <Steps>
      <Step>
        #### Go to the OnlyFans API console -> API Keys \[!toc]

        ![](/images/api-keys-nav-item.png)
      </Step>

      <Step>
        #### Create a new API key from the OnlyFans API Console \[!toc]

        ![](/images/create-api-key-button.png)
      </Step>

      <Step>
        #### Give it a name, and press "Add" \[!toc]

        ![](/images/api-key-creation-form.png)
      </Step>

      <Step>
        #### Copy the API key to your clipboard \[!toc]

        ![](/images/save-api-key.png)
      </Step>
    </Steps>
  </Step>

  <Step>
    Paste the API key into the **"API Key"** field, and click **"Save"**.
    ![Enter credentials](/images/n8n/enter-credentials.png)
  </Step>
</Steps>