The following steps are required to configure iCompleat and provide you with the correct security measures to begin building your own API powered connector:
If you are concerned your API key has been compromised, regenerate it to invalidate your key and replace it with a new one.
Follow these steps to delete your key.
On the homepage, select Configuration.
Select Company management.
Select API.
On the Security Key field, select the icon to generatea new key. A new Security key is generated rendering your old key void.
Make a note of the newly generated key or select the icon to copy to your clipboard.
Configuring an endpoint location
An endpoint is the URL where your service can be accessed by a client application. It's a requirement with our API integration to configure an endpoint location for post approved order, invoice and credit note data.
We recommend sending requests to a secured HTTPS endpoint.
Follow these steps to set an Endpoint location:
On the homepage, select Configuration.
Select Company management.
Select API.
Simply paste your endpoint url into the dedicated fields for orders, invoices and credit notes.
Select Save.
Use the same URL in all 3 fields if you have chosen not to specify separate endpoints for orders, invoices and credit notes.
As an added level of security to your API integration, we’ve implemented a token-based authentication system which can be sent as an additional parameter in your header data. This will enable you to verify that the data has come from a trusted source.
Follow these steps to access the API page and set a Secret token code.
On the homepage, select Configuration.
Select Company management.
Select API.
You can either:
Option 1
1. Use the auto-generated code in each field.
2. Copy the code to your clipboard using the icon.
Option 2
1. Delete the pre-populated code from the field and type a custom code as the token instead.
2. Copy to your clipboard using the icon. 3. Select Save.
In addition to a Security key, our APIs require you to submit a Tenant ID and Company ID to access the appropriate data.
Follow these steps to get your Tenant and Company IDs.
On the homepage, select Configuration.
Select Company management.
Select API.
Your IDs are displayed on screen.
Select the icon to copy an ID to your clipboard.
You are now ready to go!
You should now be fully configured and have the relevant keys and IDs to use our package on building an API powered connector.
Please viewthe section below on pushing data from iCompleat and how to acknowledge and respond with the transaction's journal number.
Receiving approved transaction data from iCompleat
Once a transaction has been fully approved in iCompleat, the transaction data will be sent automatically to your pre-configured endpoint via our webhooks.
If you haven’t added your endpoint details into iCompleat, see configuring an endpoint location to set the paths which your data will be sent to.
You can either specify separate endpoints for orders, invoices and credit notes, or you can use the same endpoint for all.
After your endpoint has received an approved transaction from iCompleat, you must acknowledge the message and respond with a journal number. The journal number will appear within iCompleat.
If a journal number is not returned to iCompleat, it will result in iCompleat recording the transaction as a posting failure.
If you are using Postman as your API test tool, you can download a sample collection for both invoice and order data. Follow these steps to access our sample collection:
From the homepage, select Configuration.
Select Company management.
Select API.
At the bottom of the page, select the different sample data to download.
Feel free to use these samples as you see fit when testing your API calls.
Used to add a single account code to an existing company, or update a single account code. A code and name is provided. If the code exists, then it is updated with the new name. If the code does not exist, it is added.
Used to add a single tax code to an existing company, or update a single tax code. A code and name is provided. If the code exists, then it is updated with the new name. If the code does not exist, it is added.
Used to add a single currency code to an existing company, or update a single currency code. A code and name is provided. If the code exists, then it is updated with the new name. If the code does not exist, it is added.
Used to add a single delivery site to an existing company, or update a single delivery site. A code and name is provided. If the code exists, then it is updated with the new name. If the code does not exist, it is added.
Used to add a single custom field list item to an existing custom field, or update a single custom field list item. A code and name is to be provided. If the code exists, then the name in the existing record is replaced with the new name provided. If the code does not exist, the record is added.
Used to add a single supplier to an existing company, or update a single supplier. At least a code and name is to be provided. If the code exists, then all data in the existing record is replaced with the new data provided. If the code does not exist, the record is added.