fusion-help-api（fusion help API 搜索）

Fusion Help API

Use this skill when a developer or admin needs to interact directly with the Fusion Help REST API — whether to read help content in their own app, build custom tooling, or automate content management.

When to use

• App developer wants to display help articles, FAQs, or release notes inside their Fusion app
• Developer building a custom CLI or automation script to manage help content
• Admin wants to programmatically create, update, or delete help documentation
• Developer needs to search or suggest help content from their application
• Someone wants to understand the Help API endpoints, authentication, or data models
• Building an integration that reads help content for another system

When not to use

• Using the fhelp CLI tool to sync markdown docs (use the fusion-help-docs skill instead)
• Modifying the Fusion.Services.Help backend service code
• General REST API questions unrelated to Help

Required inputs

Instructions

1. Discover the Help API base URL

The Help API is registered in the Fusion service discovery. Resolve the URL dynamically or use the known patterns:

Dynamic discovery (recommended for production tooling):

GET https://discovery.fusion.equinor.com/service-registry/environments/{env}/services

Look for the service with key: "help" in the response. Use the uri field as the base URL.

2. Authentication

All endpoints require a valid Azure AD bearer token. Token audiences and code samples for frontend, backend, and CLI are in references/authentication.md.

Quick reference — token audiences:

3. Authorization levels

4. Call the API

Endpoints are versioned — include ?api-version=1.0 in requests. Resources: Articles, FAQs, Release Notes, Assets, Search/Suggest, Changelog.

For full CRUD details, request/response bodies, OData filters, and validation rules see references/api-endpoints.md.

For a compact endpoint matrix and OData cheat sheet see references/api-quick-reference.md.

For detailed response model schemas see references/response-models.md.

5. Integration patterns

Ready-to-use code samples for common scenarios (React component, release notes banner, FAQ search, C# backend automation, Python scripting) are in references/integration-patterns.md.

Expected output

When this skill completes, the user should have:

• Working code to authenticate and call the Help API
• Correct endpoint URLs and query parameters for their use case
• Understanding of the response models and OData query options
• For admin use cases: correct request bodies for create/update/delete operations
• For integration patterns: sample code in the relevant language/framework

Safety & constraints

• Read-only endpoints are safe for any authenticated user — no admin permissions needed
• Write operations require app admin, trusted application, or Fusion.Help.FullControl
• Deleted articles/FAQs/release notes are soft-deleted — their slugs cannot be reused
• The sourceSystem field tracks which tool created a record — mixing source systems for the same slug will cause the fhelp CLI to refuse updates (unless --no-validation is used)
• Always test against ci environment before targeting fprd (production)
• Do not hardcode bearer tokens — always use DefaultAzureCredential or equivalent token providers
• Image uploads must be PNG format; the API processes them into WebP for serving