Colour theme
Book a consultation

Checking a business API integration

Review credentials, permissions, incoming data, webhooks and failure handling before a custom API integration starts moving business records.

An illustration of a checklist on a clipboard in front of buildings and clouds.

A custom connection between your accounting software and sales system needs more than a successful demonstration. Before it starts moving live records, ask the developer to show what it can access, how it handles unexpected data and what happens when either system fails.

Use the SaaS integration review for supplier terms, data flows and consent. This checklist focuses on the technical evidence you’ll need when commissioning or maintaining an API connection.

Define the actions and test their limits

Document which records and fields the connection can read, create, change or delete. Identify the authoritative system and the business owner who decides on changes to that scope.

In a separate test environment, demonstrate that the intended action succeeds and an action outside its permissions fails. Test another customer’s record identifier, a restricted field and an operation outside the integration’s role. A valid login or token shouldn’t open every record.

The OWASP API Security Top 10 identifies authorization failures, uncontrolled resource use and unsafe trust in other APIs. Use those categories to ask the developer for specific tests and their results.

Check credentials and their replacement process

Give the connection a dedicated identity or credential with the supported minimum permissions. Separate test and production credentials. Avoid using a staff member’s administrator account as the permanent connection owner.

Ask where secrets are stored, who can retrieve them and how access is recorded. They shouldn’t appear in source control, browser code, support tickets or ordinary logs. OWASP’s secrets-management guidance covers storage, lifecycle and revocation.

Have the developer demonstrate replacement and revocation using a test credential. Record expiry dates and who responds before expiry. If the platform supports a managed identity or workload identity federation, which avoids storing a long-lived secret, consider using it.

Treat incoming data as untrusted

Use encrypted connections and validate the remote service’s certificate. Validate the fields, types, sizes and allowed values received from the other system before using them. A reputable supplier can still return malformed data or data supplied by its own users.

OWASP’s REST security guidance addresses transport, endpoint access, validation and safe error handling. Ask for tests covering unexpected fields, oversized responses and invalid values. Check that a failed validation doesn’t partly update a live business record.

When the API supplies a link to an attachment, restrict the destinations the connection can retrieve. Don’t let an external response direct your server to internal services or arbitrary download locations.

Verify webhook messages and repeated events

A webhook lets a supplier send an event to your system, such as an invoice being paid. Anyone who finds its public delivery address can send a message to it.

Verify messages using the supplier’s documented authentication or signature process. OWASP’s webhook guidance also covers replay protection and idempotency: processing a repeated event without repeating its business effect.

Test an invalid signature, an old event and the same event delivered twice. Define what should happen if events arrive out of order. For example, a duplicate payment event shouldn’t issue a second refund or repeat a notification that has financial consequences.

Bound failures, retries and costs

Agree on request timeouts, batch limits and retry limits. Confirm how the supplier signals throttling and service outages. Use its documented retry instructions and test the behaviour.

For an operation that creates or changes records, a timeout can mean the action completed but the reply was lost. Check the outcome or use the API’s supported deduplication mechanism before repeating it. Don’t assume every write can safely be retried.

Keep failed items in a reviewable state with an alert to the operational owner. Record enough to reconcile the failure without logging credentials or unnecessary personal information. Define a manual fallback for work that can’t wait; don’t automatically send confidential records to some other service as a fallback.

Require an operational handover

Keep the supported API versions, retirement notices, credentials, test results and recovery instructions in your organization’s records. Name who monitors failures and who maintains the code when an API changes.

Practise pausing the connection, confirming that new work stops and reconciling unfinished items before restart. Have the business owner sign off on production use once the acceptance tests pass.

Talk to us if you need help building or reviewing a connection between your business systems.


Featured Image Credit