Revision as of 10:33, 28 September 2021

Getting started

Go to API overview

Like the web application, the API has an annual support fee based on the size of organisation. The fee is reduced in the 2nd and subsequent years to reflect the fact that the automation that API's typically encourage tend to reduce the amount of support required from our techical teams. The API support fee is invoiced separately to your main support fee.. Please contact the office for details.

The process

• Your developer will need a Source key. We send this by text message. If they have already worked with the API, they will already have this. Bear in mind that for more technical users, you may be your own developer.
• Next we will enable the API for one of your replica systems. You can then create the Org and User keys in the web application. See API Authentication. NB, if you subsequently use the Update Replica Database feature on this system, it will wipe the keys. Simply tick the box again to create new ones.
• Once you have tested your solution on the replica system, we will enable the API for your live system.
• Finally, you can create the Org and User keys in your live system, and swap the keys in your solution,.

Tools

If you use Postman (see https://www.postman.com) for testing your API calls, we can send you JSON file, with lots of sample calls, which you can import, to help get you started. Postman can use environment files to avoid storing keys as part of the API calls. You will need an environment with variables called source, org, user and host. Set host to api.dizions.co.uk