Satori Cloud
API documentation

External API documentation from Confluence

Publish API setup guides, authentication instructions, implementation notes and troubleshooting content from Confluence without giving developers or partners access to your internal workspace.

Publish your API docs See how it works
Confluence stays the source Publish selected pages No Confluence login for readers

Acme Developer Docs

API integration guide

Documentation

Getting started
Authentication
Environments
Integration guide
Troubleshooting

Getting started

Make your first API request

Before sending your first request, create your credentials and choose the environment you want to use.

POST /api/v1/resources

Authorization: Bearer ...

Confluence publishing advisor

How should you share your Confluence content?

Answer four quick questions to find the best way to share Confluence pages with customers, partners, employees, or the public.

Get a clear recommendation in under a minute

We will compare public links, anonymous access, guest access, manual sharing, and publishing as a simple website.

The problem

Developers need the documentation. They don't need your whole workspace.

API guidance often ends up in Confluence because product, engineering, implementation and support teams already use it to document how integrations work.

That can include valuable external material: getting-started instructions, authentication steps, environment information, implementation guidance and troubleshooting.

The difficulty starts when a customer, partner or external developer needs that content. Giving them access to Confluence is often far more access and interface than the job requires.

External sharing

The content can be right while the sharing model is wrong.

Confluence access is too much

A partner may need five integration pages, not an account and access to an internal collaboration environment.

Public access can be broader than needed

Making Confluence content public through the workspace itself is a different model from publishing a selected external docs set.

PDF exports go stale

Authentication steps, environments and integration guidance change while the exported document remains frozen.

Copied docs drift

Moving the same guidance into another CMS creates another version somebody has to remember to update.

Internal pages feel internal

External developers usually need focused guidance rather than internal collaboration context and workspace navigation.

Developers need a path

A good journey takes somebody from access and authentication through implementation and troubleshooting.

What to publish

Publish the guidance around the API, not every engineering note about it.

Choose the pages that help an external developer understand, access, integrate with and successfully use your API.

API overview

Explain what the API does, who should use it and where to begin.

Getting started

Take a developer from first visit towards their first successful request.

Authentication and access

Explain credentials, OAuth flows, scopes, permissions and access-request steps.

Implementation guidance

Publish integration patterns, setup guidance, environments and practical implementation notes.

Troubleshooting

Help developers diagnose common errors, environment problems and failed authentication.

Changes and migrations

Explain version changes, deprecations, migrations and other updates developers need to act on.

What Satori is — and isn't

Keep your generated API reference. Publish the human guidance around it.

Satori Cloud is not an OpenAPI renderer, Swagger replacement or endpoint-reference generator.

It is useful when the explanatory material around your API lives in Confluence: onboarding, authentication guidance, implementation instructions, architecture notes, troubleshooting and release information.

OpenAPI / Swagger

Structured endpoint reference

Paths, methods, schemas, parameters and machine-readable API definitions.

Satori + Confluence

Explanatory developer guidance

Getting started, authentication, integration guidance, troubleshooting and implementation knowledge.

How Satori works

Keep the API knowledge in Confluence. Publish the external subset.

01

Connect Confluence

Connect the workspace containing your API and integration guidance.

02

Select external pages

Choose the pages developers, customers and partners should be able to read.

03

Sync and preview

Pull the latest source content into the Satori draft and check it before release.

04

Publish

Explicitly update the live external documentation when the draft is ready.

One maintained source

Don't maintain the same integration guide in two places.

Maintained internally

Confluence

Product and engineering teams maintain the implementation knowledge they own.

Published externally

Developer documentation

External readers get the selected guidance intended for them.

When this approach fits

Use it when the API guidance already exists, but the audience is changing.

Your internal teams already maintain useful API or integration guidance in Confluence.

Customers, developers or partners need that guidance without needing workspace access.

You want to publish a selected subset rather than expose an entire internal content area.

You need narrative documentation alongside — not instead of — your generated API reference.

Bigger developer experience?

Need a broader destination for developer resources?

If the requirement goes beyond API guidance into a larger collection of developer setup, integration and technical resources, look at the developer-portal use case.

Developer portal guide

Related use cases

Connect API guidance to the rest of your customer documentation.

Product documentation

Publish broader customer-facing product guides from Confluence.

Explore product docs →

Customer onboarding

Combine technical setup with the rest of the customer's onboarding journey.

Explore onboarding →

Publish without Confluence access

See the broader model for publishing selected Confluence pages externally.

Read the guide →

FAQ

External API documentation from Confluence

Can I publish API documentation from Confluence externally?

Yes. Satori Cloud lets you connect Confluence, select the relevant API guidance and publish those pages as a separate external documentation site.

Do external developers need Confluence accounts?

No. Readers use the published Satori site rather than logging into your Confluence workspace.

Do I need to make the Confluence space public?

No. Satori's model is to publish the pages you select as a separate site rather than use the Confluence workspace itself as the external destination.

Does Satori replace OpenAPI or Swagger?

No. OpenAPI and Swagger are appropriate for structured endpoint reference. Satori is for publishing the explanatory guidance your team maintains in Confluence, such as onboarding, authentication, implementation and troubleshooting documentation.

What API documentation should I publish?

Good candidates include getting-started guides, authentication instructions, access steps, environment information, integration guidance, troubleshooting and migration information.

What happens when the API guidance changes?

Sync the latest Confluence content into the Satori draft, preview the update and explicitly publish when you are ready for the live documentation to change.

Can I use this for partner API documentation?

Yes. It can work well when partners need selected integration, setup and support guidance but do not need access to the internal Confluence workspace.

The API guidance is already in Confluence. Publish the version developers need.

Connect Confluence, choose the external API pages and publish them without giving readers access to your internal workspace.

Publish your API docs