Skip to main content

Developers · Guides

Guides

Every developer guide, with a line on what each covers.

  • Authentication: Get a 5-day Bearer token from a credential with the OAuth 2.0 client-credentials grant, send it on every request, and choose the scopes a credential holds.
  • Pagination: Read a long list 50 records at a time with the limit, gt and lt parameters, in ascending id order.
  • Errors: What every error code means, the status it comes with, and which ones are safe to retry.
  • Idempotency: Make every write safe to retry with an Idempotency-Key, and update a record at the version you read with If-Match.
  • Webhook signature verification: Check the Backed-Signature header on every webhook delivery with HMAC-SHA256, in Node.js or Python, and answer in time.
  • Connect Power BI: Load the OData reporting feed into Power BI Desktop, with Basic authentication or a token query, and refresh it on a schedule.
  • Connect Tableau: Connect Tableau Desktop to the OData reporting feed with the credential as a user name and password, and load it into other tools and warehouses.
  • Versions and deprecation: Which version is current, why a breaking change only ever comes under a new version path, and how long a superseded version stays.