Optional project API

A project API is an optional part of the application offer. It exposes agreed business operations to other systems. This guide explains the project controls; it is not an endpoint reference or an activation of the option.

Before you start — Review availability in the actual project offer and identify the operations needed by another system. This article explains the optional project workflow; usable endpoints belong to the project’s published API reference.

Review whether the project has an API

Check the offer before assuming the project has an active API.

1. Open Your offer.
2. Find API option.
3. Read whether it shows Activated or Not activated for the project.
4. Review the displayed price and conditions before clicking Activate the API option.

An application can be built and operated without enabling this option. A declared external connection does not automatically enable an API of your own.

Follow preparation for an eligible project

Follow eligible scope and prerequisites before treating the catalogue as usable integration work.

1. Open API once the option is activated for the project.
2. Click Launch the API construction. It is available once the API infrastructure is installed and at least one module is fully built.
3. Follow Modules to expose and each module's status, and use Answer when clarification is requested.
4. Follow the infrastructure and construction state shown by the overview.

If preparation is not complete, follow the stated prerequisite. The option state and finished endpoint availability are separate facts.

Check which routes are live

A method and path describe an operation; its live state establishes availability.

1. Open the API route catalogue for an activated project.
2. Read Method, Path and Description.
3. Check Status for each route.
4. Distinguish Planned from Live.

A planned route describes intended scope; it is not evidence that an endpoint already responds.

Find the right integration information

Identify the integration direction so the information belongs to the service you intend to call.

1. Decide whether you need to expose your application or use another provider's service.
2. Use the project API controls for exposure of your own operations.
3. Use External connections for another provider's documentation and access.
4. Consult the actual project's API reference only when its live API is published.

The correct provider information or live project reference is identified.

Note — Do not derive an endpoint URL or authentication example from a planned route. Use the live reference belonging to the project and environment concerned.

Using another provider’s service is an external connection. Letting another application call your own agreed operations uses the optional project API. These needs can coexist, but declaring the first does not create or activate the second.