Difference between revisions of "API: purchasing"
(→Getting started) |
(→The process) |
||
| (18 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
[[API Details| Go to API overview]] | [[API Details| Go to API overview]] | ||
| − | + | ||
| − | + | =What your software developer will need= | |
*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. | *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]] | + | *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. | ||
| + | |||
| + | =Fees= | ||
| + | Like the web application, the API has an annual support fee based on the size of organisation. There is no limit on the number of transactions or end points you can access (subject to fair use). There are 2 licences: | ||
| + | |||
| + | 1) Read and write, which is typically used to integrate with other applications and do data cleansing. The fee is reduced in the 2nd and subsequent years to reflect the fact that the automation that API's typically encourage tends to reduce the amount of support required from our technical teams. The first year fee is £750+VAT and the second year is £500+VAT. | ||
| + | |||
| + | 2) Read-only, which is typically used for reporting dashboards. This has a flat annual fee of £350+VAT. | ||
| + | |||
| + | The module is fully supported, which means as well as regular updates (typically monthly), we'll work with you and your developers to get you up and running. | ||
| + | |||
| + | The API support fee is invoiced separately to your main support fee. Please contact the office for details. | ||
| + | |||
| + | =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 | ||
| + | |||
| + | =API Keys= | ||
| + | The source key will be sent via SMS message to the phone number you provide on the order. You will require the Org and User keys which is setup on each user that requires API access. Please see [[Users#3rd_Party_System_Access_.28Obtaining_Org_and_User_API_keys.29| Obtaining Org and User API keys]] | ||
Latest revision as of 11:43, 23 April 2024
What your software developer will need
- 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.
Fees
Like the web application, the API has an annual support fee based on the size of organisation. There is no limit on the number of transactions or end points you can access (subject to fair use). There are 2 licences:
1) Read and write, which is typically used to integrate with other applications and do data cleansing. The fee is reduced in the 2nd and subsequent years to reflect the fact that the automation that API's typically encourage tends to reduce the amount of support required from our technical teams. The first year fee is £750+VAT and the second year is £500+VAT.
2) Read-only, which is typically used for reporting dashboards. This has a flat annual fee of £350+VAT.
The module is fully supported, which means as well as regular updates (typically monthly), we'll work with you and your developers to get you up and running.
The API support fee is invoiced separately to your main support fee. Please contact the office for details.
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
API Keys
The source key will be sent via SMS message to the phone number you provide on the order. You will require the Org and User keys which is setup on each user that requires API access. Please see Obtaining Org and User API keys
