API integration service: two systems connected for a fixed scope
A written scope, a link built on official interfaces and tests that include failures.
Some businesses reach the point where the ready-made connector does not do the job, and orders, leads or invoices are copied between two systems by hand. This page is for that case: one link between two systems, built through their programming interfaces (APIs), with the scope written down first. True North Innovations is a Melbourne-based team that works with businesses across Australia. This page covers one link between two systems. If you need to connect an ERP, see ERP integration. If you are not sure which of the integration pages fits, see system integration.
Written scope · Official interfaces · Test cases with failures · Log and alerts
Melbourne based.
Australia-wide delivery.
Melbourne · Sydney · Brisbane · Perth · Adelaide · Canberra
When the ready-made app is not enough
A ready-made connector is the right answer when it covers your case. These are the signs that it does not.
Data is copied by hand
A new order, lead or invoice is typed again into a second system. Mistakes and delays come from that copying.
The connector misses a field
The app moves the name and the total but not the field your business depends on, or it moves data only one way.
Your own rules are needed
Something must happen only in some cases, for example only for a certain customer type or only above a certain stock level.
Nobody knows when it fails
A link that stops quietly is worse than none. You need a log and an alert when a record does not arrive.
The kinds of pairs we connect
We build on the official interfaces of both systems. We check what each interface allows before we promise anything.
Website forms and a CRM
An enquiry or order on your website becomes a record in your CRM. See custom CRM development.
CRM and accounting
Customers and invoices move between the system that sells and the system that bills.
Shop and stock or shipping
Orders go to the stock, packing or delivery system, and the status comes back.
Website and an outside service
A booking tool, a payment gateway, a mail tool or a data service joined to your website.
Two systems you built or bought
Software with an API on each side, including your own database or an in-house tool.
A pair that needs several steps
Where several systems and approvals are involved, see workflow automation.
Our own platform connects website forms, CRM systems and outside services. We have not listed customer jobs here and we do not claim any.
How we scope one integration
The scope is written before any build. It is what you agree to, and what the tests are written against.
- 01
Read
We read the interface documents of both systems and check what your plan or licence allows.
Output: A list of what each side can and cannot do
- 02
Write the scope
We write the fields to move, the direction, the timing, and what happens when a record fails.
Output: A written scope for you to agree
- 03
Build
We build the link on the official interfaces, using a test account where one exists.
Output: A working link in a test setting
- 04
Test
We run at least 10 test cases, including failures, and a person signs them off.
Output: Test results
- 05
Hand over
We switch it on, set up the log and alerts and write the hand-over note.
Output: A hand-over note and 30 days of support
Tests and failure cases
A link is only as good as its worst day. These are the kinds of failure we write a test for.
A person signs off the test cases before the link is switched on.
What you receive
A written scope
Fields, direction, timing and failure cases, in plain English.
The link
Built on the systems' official interfaces, in your own accounts where possible.
At least 10 test cases
Including failures, with results you can read.
A log and alerts
A record of what moved and a message when something did not.
A hand-over note
Who looks after what, and where to look when something stops.
30 days of support
For questions and fixes to the agreed scope after the switch-on.
Turnaround is usually 2 to 3 weeks, once we have access.
What you give us to start
- Interface keys or admin access for both systems, set up inside your own accounts.
- A test account for each system where one exists.
- A list of the records and fields that must move, and in which direction.
- Three or four real examples, including one that went wrong before.
- Who signs off the test cases, and who receives the alerts.
What is not included
Accounting advice
We connect the systems. How you account for the data is a question for your accountant.
Fees of the systems
Licences and interface charges of each system are paid by you to its maker.
Unlimited changes
Changes inside the agreed scope are covered. A new field or a new system is a new scope.
What affects the scope
The size of a job depends on how many fields move, whether data goes one way or both, how many failure cases matter to you and how good the interface of each system is. A system with poor documents or tight limits takes longer. We write the scope first so you know what you are agreeing to.
If the work turns out to be several links or an ERP, we say so. See ERP integration for that. For one link between two systems this is the right page; system integration covers the same method when the word you use is systems rather than APIs.
API integration service: good to know
What is an API integration?
It is a link between two software systems that uses their official programming interfaces, so data moves between them without anyone retyping it.
When is a ready-made connector enough?
When it moves the fields you need, in the direction you need, and tells you when it fails. If it does, use it. We build only when it does not.
What do you need from us to start?
Interface keys or admin access for both systems, a test account where one exists, and a list of the fields to move. The full list is on this page.
How long does it take?
Usually 2 to 3 weeks after we have access. A system with tight limits or poor documents can take longer, and we tell you when we see that.
What happens when one system is down?
The record waits and is tried again a set number of times. When the limit is reached, an alert is sent. Nothing is entered twice.
How do I know it is working?
The link keeps a log of what moved and sends an alert when a record does not arrive.
Who signs off the tests?
A person signs off the test cases before the link is switched on. We write the cases, including failures, and you see the results.
Do you build it in our own accounts?
Where possible, yes. The keys, the logs and the link itself belong in accounts you control.
Is accounting advice included?
No. We connect the systems. How the data is treated in your books is for your accountant.
What if we need to change a field later?
Changes inside the agreed scope are covered during the 30 days of support. A new field or a new system is scoped as a new job.
What if I need to connect an ERP?
See our ERP integration page. It covers the extra care an ERP needs.
Can several steps and approvals be added?
That is a workflow rather than one link. See workflow automation.
Related services
The same method, for business systems that must work together.
When one of the systems is an ERP.
For whole processes with several people and approvals.
A system to hold the records your links read and update.
Tell us which two systems you want connected
Name the two systems and what has to move between them. We will explain the clearest next step, in plain English.
Call 03 4158 4444info@truenorthinnovations.com.au
Every job is scoped before work starts.