IFS Integration APIs allows businesses to create new applications or connect
applications without having to invest development time in starting from scratch.
For that, IFS API documentation is available through $openapi which
outputs the documentation according to the Open
API standards (OAS) in
JSON format.
The OpenAPI Specification (OAS) defines a standard, language-agnostic interface
to RESTful APIs which allows both humans and computers to discover and
understand the capabilities of the service without access to the source code,
documentation, or through network traffic inspection. When properly defined, a
consumer can understand and interact with the remote service with a minimal
amount of implementation logic.
This API Documentation is feasible to be used
by documentation generation tools to display the API, code generation tools to
generate servers and clients in various programming languages, testing tools,
and many other use cases. (Eg: Azure Logic Apps, Microsoft Power Apps) In a CORS
enabled environment, you will be able to use the link directly. Otherwise, save
the generated JSON and import it.
The End point will be
https://<Server>:<port>/int/ifsapplications/projection/v1/<name>.svc/$openapi
We recommend SOAP API and Swagger to test the JSON generated using $openapi.
To view all the available integration projections, please use
https://<Server>:<port>/main/ifsapplications/projection/v1/AllProjections.svc/Projections?$format=json&$filter=Categories%20eq%20%27Integration%27
Version support is given using the query parameter V{API Version Number}. It is supported for the major releases and by default $openapi endpoint suports for OAS 3.0 version.
For OAS 2.0(fka Swagger)
https://<Server>:<port>/int/ifsapplications/projection/v1/<name>.svc/$openapi?V2
For OAS 3.0 use
https://<Server>:<port>/int/ifsapplications/projection/v1/<name>.svc/$openapi or
https://<Server>:<port>/int/ifsapplications/projection/v1/<name>.svc/$openapi?V3
IFS REST API Documentation is a API visualizer which helps to visualize the
endpoints available ,corresponding request / response payloads, expected error
codes and accepted query parameters.