Modified on: Tue, 11 Oct, 2016 at 10:36 PM
Inventory API is part of DEAR Inventory web application at
https://inventory.dearsystems.com. You will need to create an account there
before you can use the API. Trial accounts are also allowed to access the API.
API URL is https://inventory.dearsystems.com/externalapi/. To call any
API endpoint (method) you must append the endpoint name and parameters to the
API URL. eg:
API accepts only JSON data format.
assume that the API is actually online at any time. Always queue requests to
the API so that you can retry the request in the event of a network failure:
even if our server is up 24/7 forever, the network will not be. Consider what
happens in the case of a network interruption, eg the cable gets cut by road
workers yet again. You should always plan to add all requests to a queue so
that they can be tried again in the event of any failure.
documentation of each endpoint is available on that endpoint's help page. This
includes the operations supported and the full list of available fields with
name, type, length and required values. A list of all endpoints is given in the
"API Endpoints" topic. Use our API Explorer to see examples of each
Inventory API is a subset of the functionality available through DEAR Inventory
UI - check the API documentation to see if the functionality you require is
available in the API.
the event of errors, the API will return an appropriate HTML status code, and
an error message. You will need to read both the status code and the error
message to establish the cause. Typical error messages are documented on the
“API Status Codes” topic page.
Did you find it helpful?
Sorry we couldn't be helpful. Help us improve this article with your feedback.