ABM API for web developers
Overview
This product has been developed as a modular API to interface with the ABM product. The API is delivered as a series of web services that are primarily based around the REST development practice.
The objective of the product is to provide a unified process to retrieve, insert and update information within the ABM system, this is achieved by the creation of documents. Each of these documents wraps up the logical table structure in ABM into structured documents containing all information required.
The API will provide features such as complex queries, transaction on document submission, ability to handle multiple concurrent requests, data extensibility along with flexibility in the structure and shape of each document.
Default Packet
All responses back from the API will be encapsulated within a standard response structure. This structure my be extended in the future to support additional features such as parked jobs, response paging or even more detailed statistics of internal document processing performance.
Response
<response>
<data> </data>
<perf>
.. performance data
</perf>
</response>
3 Access
All endpoints will accept GET, POST and PUT requests, the definition of the action will be defined by the endpoint.
3.1 Endpoints
| /{entity} | GET and POST |
Will allow GET with parameters, or POST with XML data to query products in the database. The GET method is used to configure simple query parameters, while the POST function submitting XML will allow much more powerful queries to be performed. |
| /{entity}/id/{code} | GET | Will retrieve the “entity” with the defined primary identifier of “code”. This format allows parameters to be sent which will modify the format, layout and detail of the resultant packet. |
| /{entity}/create | POST |
Submitting an XML document correctly formatted that contains at least the minimum required fields to this endpoint will result in a new record being created. The response to this request will contain the same information submitted, along with any server side generated values or application defaults used to create the entity. On some endpoints this function may fail if duplicate items are detected, while on others a create may not occur, but just return the existing item in the database. This will be defined per entity. |
For more information please contact us.