An external integration web page is a custom endpoint created on your system, which receives requests from an external integration form, and returns either an XML, JSON, or HTML response. The external integration web page can be created using any programming language, or hosted on any web server. The only requirement is that it can receive an HTTP POST and return either an XML, JSON, or HTML document.
For the example used in this series of External Integration articles, we have created a WebAPI application and hosted it on the ASP.NET framework. This service will accept a POST request at your websitedomain.com/api/Water/Bill and expects a BillRequest object. You can see how to post to this endpoint using any of the three protocols in our example WebAPI's Information Request page.
In-Article Glossary
Review the Municipal Websites Central's Glossary of Terms for a comprehensive explanation of the acronyms, abbreviations, and company-specific terminology. The terms located in this section are listed alphabetically:
- HTML: Hypertext Markup Language
- HTTP: Hypertext Transfer Protocol
- JSON: JavaScript Object Notation
- WebAPI: Web Application Programming Interface
- XML: Extensible Markup Language
Feedback About the Article
Let us know what was helpful or not helpful about the article below.0 comments
Please sign in to leave a comment.