> ## Documentation Index
> Fetch the complete documentation index at: https://docs.logictwelve.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Usage

> Use API Docs Embed for Apidog day to day

Page viewers see the embedded Apidog documentation page rendered in place, with no Confluence-specific chrome around it.

If the macro doesn't have a usable URL configured, viewers see a configuration warning instead. If the URL isn't on the `apidog.com` domain, they see an invalid URL warning. If the site doesn't have an active license, they see a license warning instead — see [Licensing](#licensing).

## Adding the macro to a page

<Steps>
  <Step title="Open the macro browser">
    While editing a page, type `/` or click the **+** in the editing toolbar.
  </Step>

  <Step title="Find and select the macro">
    Search for "Apidog" and select **API Docs Embed for Apidog**:

    <Frame>
      <img src="https://mintcdn.com/logictwelve-a6acb4a5/ri-T8bkJTW8gw2zt/apidog-embed/images/macro-picker.png?fit=max&auto=format&n=ri-T8bkJTW8gw2zt&q=85&s=a117c90b885318ac6a6c1dab6fd8b0de" alt="Macro picker showing the API Docs Embed for Apidog macro" width="762" height="596" data-path="apidog-embed/images/macro-picker.png" />
    </Frame>
  </Step>

  <Step title="Set up the macro">
    Fill in the **URL Resource** and **Height** fields — see [Configuration](/apidog-embed/configuration) for details.
  </Step>

  <Step title="Save">
    Click **Save** on the macro, then save the page to make the embedded documentation visible to viewers. Here's how the macro looks once published:

    <Frame>
      <img src="https://mintcdn.com/logictwelve-a6acb4a5/ri-T8bkJTW8gw2zt/apidog-embed/images/macro-rendered.png?fit=max&auto=format&n=ri-T8bkJTW8gw2zt&q=85&s=ba6be5a340e7ea15de42228b891d468a" alt="Rendered API Docs Embed for Apidog macro on a published Confluence page" width="2872" height="1726" data-path="apidog-embed/images/macro-rendered.png" />
    </Frame>
  </Step>
</Steps>

## Keeping it updated

The macro embeds the configured URL live, so any changes you publish in Apidog show up the next time someone views the Confluence page. There's nothing to republish on the Confluence side — only the **URL Resource** or **Height** fields need to be revisited if you reconfigure the macro itself.

## Licensing

The app uses Confluence's built-in Marketplace licensing. If a site doesn't have an active license or trial, every instance of the macro shows a license warning instead of rendering.

## Tips

<AccordionGroup>
  <Accordion title="Content isn't visible inside the macro">
    Confirm the **URL Resource** points to a published, publicly accessible Apidog documentation page — pages that require Apidog sign-in won't render inside the iframe.
  </Accordion>

  <Accordion title="Macro shows an &#x22;Invalid URL Resource&#x22; warning">
    The URL must be on the `apidog.com` domain or a subdomain of it. URLs on any other domain are rejected.
  </Accordion>

  <Accordion title="Embedded content is cut off or has extra empty space below it">
    The macro doesn't auto-resize to its content. Adjust the **Height** field in the macro configuration to match the embedded page.
  </Accordion>
</AccordionGroup>