Overview

FieldInsight Gateway

A scoped, audited interface to FieldInsight. JSON in, JSON out, one bearer key per integration.

JSON in, JSON out

Every request is JSON over HTTPS. Every response carries X-Request-Id — log it next to your own request IDs to make later debugging easier.

Scoped by key

Your key carries its own access. Reads return only the data you’re entitled to; writes attach the right customer automatically. No extra headers to manage.

Consistent field names

The same word means the same thing on both sides of the wire. If you read a job back and see number, you filter on ?number=. No this-on-write, that-on-read.

Errors as data

Errors follow RFC 7807 problem-details. type classifies the failure;instance echoes X-Request-Id.

Start here

1. Read Setup & verification — confirm your key works and discover the IDs you need.
2. Skim Authentication, Rate limits, and Errors — the conventions reused everywhere.
3. Use the reference: List jobs, Create job, Update, Cancel.
4. Subscribe to webhooks if you want push notifications rather than polling.