Public API

Figaf Tool provides a limited Public API for external integration.

API definition is available under <your app url>/swagger-ui.html of your installation.

Public API of the latest version can be checked on trial cloud distribution here.

1. Access

Calls are authenticated with an OAuth client registered in Figaf Tool. Registering one requires the IRTOAuthClientsManager role, described in User management and permissions.

2. What the API covers

Endpoints are grouped by the area they act on, all under /api/v1:

Area Groups

Testing

integration-object, recording-request, polling, message, message-sender

DevOps

ticket, transport, transport-configuration

Change tracking

ctt/agent/{agentId} (tracked objects), agent

B2B

b2b (business entities, including the create and update of partner profiles and of companies/subsidiaries), b2b-scenario, agreement, agreement-template, mig, mag, custom-message, b2b-migration

Other

event-mesh, download, mcp

The B2B groups cover the chain a migration needs, each step addressed by the ids the previous one returns: custom IDoc messages created from an XSD, then the MIGs and MAGs built on them, their activation, and the agreement templates that carry the resulting scenarios. They need a valid B2B license and their own authorities on the OAuth client - b2b.mig:execute, b2b.mag:execute, b2b.custom-message:read / :execute, b2b.agreement-template:read / :execute, b2b.partner-profile:read / :execute, b2b.company-and-subsidiary:read / :execute, b2b.migration:read / :execute - which are granted in the Add dialog of Config → OAuth Clients.

Operations that write to SAP answer 202 Accepted with a processId and are polled on the result endpoint of their group, because they run in the background.

The Swagger definition of your own installation is the authoritative reference: it lists the operations, parameters and payloads for each group, and reflects the version you are running.