API Documentation¶
Introduction¶
The IFS Integration APIs allow businesses to create new applications or connect applications without having to invest development time in starting from scratch. The 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.
Use of API Documentation¶
This API documentation can 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 such as Azure Logic Apps and 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 endpoint is,
https://<Server>:<port>/int/ifsapplications/projection/v1/<name>.svc/$openapi
We recommend Postman and Swagger to test the JSON generated using $openapi.
To view all the available integration projections, use
https://<Server>:<port>/main/ifsapplications/projection/v1/AllProjections.svc/Projections?$format=json&$filter=Categories eq %27Integration%27
Supported Versions¶
Version support is given using the query parameter V{API Version Number}. It is supported for the major releases and by default the $openapi endpoint supports the OAS 3.0 version.
For OAS 2.0 (fka Swagger), use
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