Skip to main content

Integration guideSeal API and Scripts

REST API

Exchange data and trigger actions through Seal’s API.

Illustration of a seal beside a laptop showing a data table and an evidence binder linked by a red thread.

REST API and SealSeal API and Scripts

Seal reads
Records another system writes through the API
Writes back
Records another system reads through the API
Source of truth
Agreed when scoped
Set up
Scoped with your team
Neil › Integration activity summary
draft

Summarise the records our API integration created this week.

Neil

  • I’ll use the records you can open in Seal and cite each one. Anything the integration sent elsewhere isn’t visible to me.
Reads
Records created through the API
Returns
  • Records created, with references
  • Records that failed or look incomplete
  • Follow-up for the integration owner
Illustrative work with REST API: a request to Neil, the source it reads and the draft it returns for your review.

1What’s connected.

Use Seal’s API to read and write records from another system or your own application. Agree the records, direction of transfer, credentials and failure handling for each connection before setting it up.

Connection setup and permissions

Use Seal’s APIs or scripting engine for a connection tailored to your process. Agree the data mapping, access and direction of transfer before implementation.

2Start with the job.

Tell us what Neil needs to do and which records it needs. We’ll confirm the interface, permissions and implementation scope with your team.

Discuss this connection →

3Before it goes live.

Access and any write-back

Define which records are in scope and whose permissions apply. Whether the connection writes back at all is a separate decision, with its own mapping and approval.

Data and failure handling

Agree the field mapping, identifiers, units and source of record. Test missing or duplicate data, interrupted transfers and recovery before relying on the connection.

Verification and release

Review the configured connection for its intended use. Keep the requirements, checks and evidence with the change, and approve the release through your team’s controls.

Read the assurance detail →