REST API and SOAP API
Bravura Security Fabric supports two types of web services: REST API and SOAP API.
REST (Representational State Transfer) API uses HTTP requests to retrieve and modify data. It follows a client-server architecture where the server provides data resources and the client interacts with these resources using standard HTTP methods like GET, POST, PUT, and DELETE. REST API uses standardized formats such as JSON (JavaScript Object Notation) or XML (Extensible Markup Language) for data exchange. It is stateless, meaning each request from the client to the server contains all the necessary information to execute the request, and no session state is stored on the server. REST APIs are widely adopted in modern web, cloud and mobile applications due to its lightweight nature.
SOAP (Simple Object Access Protocol) API uses the XML format to send and receive data. Like the REST API, it also follows a client-server architecture. SOAP APIs use standardized methods such as GET, POST, PUT, and DELETE for data exchange. However, the structure of the data is more complex. SOAP APIs are stateful, meaning they maintain session state on the server, and each request from the client to the server may rely on previous requests.
REST API and SOAP API have significant differences in architecture, data formats, and characteristics.
REST API | SOAP API | |
|---|---|---|
Architecture | Follows a stateless client-server architecture. | Follows a stateful client-server architecture. |
Data Format | Uses widely accepted data formats such as JSON, XML, or plaintext. | Uses XML only. |
Message Structure | Uses simple HTTP methods like GET, POST, PUT, and DELETE to access and manipulate data. | Uses a more complex message structure and protocol. |
Web standard | Uses common web standards such as Swagger/OpenAPI. | Uses standard Web Services Description Language (WSDL) |
Performance | Performs better than SOAP API due to its stateless architecture, which eliminates the need to maintain session state on the server. | Performs worse than REST API as its stateful architecture can lead to higher overhead. |
Flexibility | More flexible, scalable, and adaptable to changing requirements. | More rigid and complex because of its strict message format. |
Bravura Security Fabric has a suite of built-in REST API endpoints which is continuously being expanded with each release, along with hundreds of built-in method functions for the SOAP API.
The Bravura Security Fabric Remote API (api.pdf) guide provides a detailed overview of the SOAP API as well as a complete function reference.
See REST API Reference documentation for details on the REST API.