PLATE P.7.2 — API DEVELOPMENT

Custom API development so other software can work with yours

An API is the part of your software that other software talks to: addresses where a customer's ordering system, a supplier, or your own website can read your records and write new ones without anyone logging in to re-key them. It is for businesses whose system holds data others need to reach. Ozwebnet writes APIs from scratch in Adelaide, South Australia, for businesses across Australia: one fixed quote staged against milestones, and the source code handed over with the IP assigned to you.

DETAIL OF SHEET 07 — SYSTEMS INTEGRATION →

FIG. P.7.2 — THE INTEGRATION PLATE: AN API IS THE FITTING ON YOUR OWN BOX THAT OTHER SOFTWARE CONNECTS TO · HOVER TO POUR
GENERAL NOTES 02 / 07

What is an API, and why would a business need one?

An API (application programming interface) is a set of addresses your software answers on, so other software can ask it for records or send it new ones. Your website reads stock levels from your warehouse system. A customer's purchasing system sends orders straight into your job system. A supplier posts delivery updates that appear in your portal. None of it needs a person logging in. A business needs one when its own system holds data that others must reach, and the alternative is an emailed spreadsheet, a shared login or a nightly export.

SECTION A–A 03 / 07

Who should have an API built?

BUILT FOR
Businesses whose customers or suppliers ask to send orders and receive updates straight from their own systems; firms with a custom system, a database or older desktop software that a website, an app or a partner now needs to reach.
REPLACES
The spreadsheet emailed to a partner each week, the shared login a customer's staff use to re-key orders into your portal, the nightly export to a shared folder, and screens scraped because there was no other way in.
NOT FOR
A business that only needs Xero, MYOB or another off-the-shelf product connected to its systems (those already have APIs; that is an integration), or one where nobody outside yet needs to read or write its data — we will say so.
SCHEDULE OF WORKS 04 / 07

What is included in an API development build?

01

A written list of every record, field and action the API exposes

Which records other software may read, which it may create or change, and the exact name and meaning of every field — agreed in writing before an endpoint is built, and kept as the reference the other side reads.

02

Endpoints to read and write each record

An address to list records with filters and paging, one to fetch a single record, and one each to create and update it — orders, customers, stock, jobs, whatever your system holds.

03

A key for each outside party, with its own permissions

Your website, a customer's purchasing system and a supplier each get their own key, see only the records they are allowed to, and can be switched off on their own without touching the rest.

04

Checks on every request, with errors that say what was wrong

A request with a missing field or an unknown product is refused with a message naming the field and the reason, so the developer on the other side can fix it without ringing you.

05

Webhooks that tell other systems when your records change

When an order is dispatched or a price changes, the systems that asked to know are told straight away, instead of asking your API over and over to check.

06

Reference documentation and a sandbox to build against

A page for each endpoint with example requests and replies, and a test copy of the API loaded with sample data, so an outside developer can build and test without touching your live records.

07

Logs, limits and versioning

Every call is written down with who made it and when; a limit stops one caller from slowing everyone else; and changes are released as a new version, so a system already connected keeps working.

TYPICAL SCOPE FOR THIS KIND OF SYSTEM — YOUR EXACT SCOPE IS FIXED IN WRITING AT THE SPECIFICATION STAGE.

Not sure which? Ten minutes on 1300 699 321 tells you — Mon–Fri 9–5 ACST.

STAGES 05 / 07

How is an API built and priced?

One fixed quote, set in writing at the specification stage (02 Blueprint) and staged against the five milestones below. Each milestone ends with a working system; stop at any milestone and keep what has been built.

SEE THE FIVE STAGES ANIMATED 
  1. 01 SURVEY

    Discovery

    We list who needs to read or write your data — customers, suppliers, your own website or app — and which records and actions each of them needs.

  2. 02 BLUEPRINT

    Specification

    Every endpoint, field, permission and error message is specified in writing; the fixed quote is set here, staged against milestones.

  3. 03 FORGE

    Build

    Built one group of endpoints at a time, reads before writes; each milestone ends with a working API the other side can call.

  4. 04 TEMPER

    Testing

    Every endpoint is tested against the written list with bad requests as well as good ones, before any outside system is given a key.

  5. 05 DEPLOY

    Launch

    The API goes live with its documentation and sandbox, and you receive the source code with the IP assigned to you.

REQUESTS FOR INFORMATION 06 / 07

Questions before you call

RFI-01How much does custom API development cost?

One fixed quote, set in writing before the build and staged against milestones. Reads are built before writes, and each milestone is an API the other side can already call, so you can stop at the endpoints you need.

RFI-02Who owns the API once it is built?

You do — source code delivered, IP assigned to you. Your own developers, or any other, can add endpoints later.

RFI-03What is the difference between an API and a systems integration?

An integration connects software you already run, using the APIs those products expose. API development gives your own system an API, so other software — a customer's, a supplier's, your website or app — can read and write your records. Many businesses need both: the API first, then the connections that use it.

RFI-04Can another company's developer connect to our API without calling us?

Yes. Reference documentation and a sandbox loaded with sample data are part of the typical scope, and every refused request says which field was wrong and why, so an outside developer can build and test against it on their own.

RFI-05Do you build APIs for businesses outside Adelaide?

Yes — Adelaide first, Australia-wide. The API is written in Adelaide and called from wherever the other software runs.

RFQ — REQUEST FOR QUOTE 07 / 07

Get a fixed quote for API development.

Call, or answer a few short questions — what you run, what breaks, when you need it working — and we reply within one business day. The quote is fixed in writing before any build starts.

CALL 1300 699 321 Mon–Fri 9–5 ACST · REPLY WITHIN ONE BUSINESS DAY