sailing Foudra MRP

OpenAPI

The whole API is described in the OpenAPI 3.1 format at:

https://foudra.com/developers/openapi.json

It is the same API as the reference lists, in a form that tools read: every endpoint, its parameters, what it takes and what it answers. A test in Foudra's own build fails if an endpoint is added or removed without the description changing to match, so it doesn't drift from what is actually served.

What to do with it

  • Try the API by hand. Import it into Postman, Insomnia or Bruno. Set the server's company variable to your company's subdomain and the bearer token to your API key.
  • Read it in a browser. Paste the address into the Swagger Editor (File, Import URL). The description is served to any site, so this works from theirs.
  • Give it to an AI assistant that is writing your integration. It's the most accurate thing you can hand it.
  • Generate a client, with openapi-generator or a similar tool, if you want one in a language we don't show here. Generated code is only as tidy as the generator makes it; for most programs a few lines of Requests are less to look after.

Reading it

  • Every operation has an operationId and a summary, and is tagged by area (Parts, Work orders, …).
  • x-required-scope on each operation is the least scope a key needs for it: read, write or approve.
  • Decimals are strings matching ^-?[0-9]+(\.[0-9]+)?$, as everywhere in the API.
  • Files (documents, images, barcodes) are binary responses; their real type is in the Content-Type header.
  • The server is https://{company}.foudra.com. OAuth applications are given the address with their token, as company.api_base_url.