{"info":{"_postman_id":"5eea8f14-1399-4195-98bd-d6ee4b62a18a","name":"API Introduction","description":"

FactoryFour API endpoints are all authenticated. Automating actions with the FactoryFour API first requires authenticating via Auth0 to receive a token which is used to make subsequent requests.

Authentication

FactoryFour leverages Auth0 as an external authentication provider. Auth0 leverages OAuth and JSON Web Tokens (JWT's) as technology for powering stateless authentication. Users implementing FactoryFour API functionality begin by requesting a token from Auth0 which is accepted by the FactoryFour API.

This collection of requests includes a FactoryFour Auth section, which provides examples on how to use a FactoryFour username and password to authenticate with Auth0 and receive a token.

FactoryFour API

All FactoryFour functionality is powered by our single HTTP based API. All endpoints require an authentication token to be passed which can be retrieved from Auth0 via the FactoryFour Auth requests. Some sample requests have been provided here, however more comprehensive documentation can be found at the FactoryFour Learn Center. While the specific http endpoints do provide some mechanisms for data retrieval, it is recommended to leverage GraphQL for fetching. An interactive GraphQL query editor with embedded documentation on objects can be found at the FactoryFour GraphiQL Application.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"1733666","collectionId":"5eea8f14-1399-4195-98bd-d6ee4b62a18a","publishedId":"TVKJwu5z","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-09-28T19:01:52.000Z"},"item":[{"name":"FactoryFour Auth","item":[{"name":"Token Request","id":"63bd75c8-9149-41e0-a815-40324e2e506e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-","value":""}],"body":{"mode":"raw","raw":"{\n \"grant_type\": \"password\",\n \"client_id\": \"EROxMPqTUoZE21q6xD6CDnPLt2maGy6o\",\n \"username\": \"{{username}}\",\n \"password\": \"{{password}}\",\n \"connection\": \"FactoryFour-Production\",\n \"scope\": \"openid email\"\n}"},"url":"https://auth.factoryfour.com/oauth/token","urlObject":{"path":["oauth","token"],"host":["https://auth.factoryfour.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"63bd75c8-9149-41e0-a815-40324e2e506e"}],"id":"14fafab5-89bb-4406-a698-53eba7320f3f","description":"

Using a username and password, the single request in this collection will perform a POST to an Auth0 endpoint, returning an id_token. This id_token should be stored by the application performing an integration, as it can be reused across multiple requests.

The username and password can be stored as environment variables in Postman - see this document for instructions

\n","event":[{"listen":"prerequest","script":{"id":"1ae3f053-06ff-4303-8eba-3571873d49e9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1712bbb0-14a4-48c5-86d1-38ea9eb65398","type":"text/javascript","exec":[""]}}],"_postman_id":"14fafab5-89bb-4406-a698-53eba7320f3f"},{"name":"FactoryFour API","item":[{"name":"GraphQL","item":[{"name":"GraphQL","id":"cea01550-8fc8-473c-85de-3537403fd9d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"graphql","graphql":{"query":"{\n order (id:\"\") {\n id\n }\n}","variables":""}},"url":"https://api.factoryfour.com/graphql/","auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":true,"source":{"_postman_id":"4f6834ef-0fa5-4ebb-b727-cd86600cf758","id":"4f6834ef-0fa5-4ebb-b727-cd86600cf758","name":"FactoryFour API","type":"folder"}},"urlObject":{"path":["graphql",""],"host":["https://api.factoryfour.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"cea01550-8fc8-473c-85de-3537403fd9d4"}],"id":"1f1805b8-4942-42c9-b8a0-6268885c7290","_postman_id":"1f1805b8-4942-42c9-b8a0-6268885c7290","description":"","auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":true,"source":{"_postman_id":"4f6834ef-0fa5-4ebb-b727-cd86600cf758","id":"4f6834ef-0fa5-4ebb-b727-cd86600cf758","name":"FactoryFour API","type":"folder"}}},{"name":"Orders","item":[{"name":"Fetch Orders","id":"5fd37c35-0354-4f8e-8700-2c25a87d2246","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.factoryfour.com/orders/","description":"

Fetch all orders available to user.

Fetch a single order by orderId specified in URL

Update route for modifying an orders status. Status is actually a nested object consisting of a primary status and descriptor. Currently descriptor is only used by the backend and does not provide any additional information to the customer.

Valid options for primary status are: 'incomplete', 'pending', 'progress', 'complete', 'error'\nAny string is valid for descriptor.

Updating from incomplete to pending requires being logged in as a clinician. Updating from pending to progress requires being logged in with a CAST vendor account.

Datapoints follow the schema found in the body of this request. Important things to note:

there are no restrictions on code. Although fabrication organization do have datapoint schemas that specify codes, a datapoint can be created with a code that is a valid string. However, it is best to use codes that are included in datapoint schemas to allow for manual intervention should any errors occur.
Title is not required but is recommended to include for certain User Interfaces.
Datapoints are associated to orders by specify a parent as a FactoryFour Resource number. For an order this uses the template f4::order::{order_id}
Permissions are automatically assigned so that only members of your own organization can see and modify the order.

Search for datapoints of a particular order by specifying a parent for datapoints.

\n","auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":true,"source":{"_postman_id":"4f6834ef-0fa5-4ebb-b727-cd86600cf758","id":"4f6834ef-0fa5-4ebb-b727-cd86600cf758","name":"FactoryFour API","type":"folder"}},"urlObject":{"path":["datapoints","search"],"host":["https://api.factoryfour.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c9567cc9-59a1-4d0d-b6c5-ad308bebba06"},{"name":"Delete Datapoint","id":"22b6384c-885e-47f0-8c7f-615c7bd9f020","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.factoryfour.com/datapoints/5af60b981e8a47690efd0d9c","auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":true,"source":{"_postman_id":"4f6834ef-0fa5-4ebb-b727-cd86600cf758","id":"4f6834ef-0fa5-4ebb-b727-cd86600cf758","name":"FactoryFour API","type":"folder"}},"urlObject":{"path":["datapoints","5af60b981e8a47690efd0d9c"],"host":["https://api.factoryfour.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"22b6384c-885e-47f0-8c7f-615c7bd9f020"}],"id":"e0a0d3b9-a93b-4a0f-b276-2bf48c2cab14","_postman_id":"e0a0d3b9-a93b-4a0f-b276-2bf48c2cab14","description":"","auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":true,"source":{"_postman_id":"4f6834ef-0fa5-4ebb-b727-cd86600cf758","id":"4f6834ef-0fa5-4ebb-b727-cd86600cf758","name":"FactoryFour API","type":"folder"}}},{"name":"Workflows","item":[{"name":"Create Task Type","id":"57aaacd3-3dc6-491d-ba53-a00df3b98b26","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Task 4\",\n \"code\": \"t_task4\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.factoryfour.com/tasks/types","auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":true,"source":{"_postman_id":"4f6834ef-0fa5-4ebb-b727-cd86600cf758","id":"4f6834ef-0fa5-4ebb-b727-cd86600cf758","name":"FactoryFour API","type":"folder"}},"urlObject":{"path":["tasks","types"],"host":["https://api.factoryfour.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"57aaacd3-3dc6-491d-ba53-a00df3b98b26"},{"name":"Get Task Type","id":"f842571d-2ba8-4ee8-a9b0-8befe1563c09","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Task 4\",\n \"code\": \"t_task4\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.factoryfour.com/tasks/types/5f24412ab1bb5d000cf752d5","auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":true,"source":{"_postman_id":"4f6834ef-0fa5-4ebb-b727-cd86600cf758","id":"4f6834ef-0fa5-4ebb-b727-cd86600cf758","name":"FactoryFour API","type":"folder"}},"urlObject":{"path":["tasks","types","5f24412ab1bb5d000cf752d5"],"host":["https://api.factoryfour.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f842571d-2ba8-4ee8-a9b0-8befe1563c09"},{"name":"Get Workflow Drafts","id":"ff9d2eac-d862-4814-9129-1e0ec1ac2609","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.factoryfour.com/workflows/drafts","auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":true,"source":{"_postman_id":"4f6834ef-0fa5-4ebb-b727-cd86600cf758","id":"4f6834ef-0fa5-4ebb-b727-cd86600cf758","name":"FactoryFour API","type":"folder"}},"urlObject":{"path":["workflows","drafts"],"host":["https://api.factoryfour.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ff9d2eac-d862-4814-9129-1e0ec1ac2609"},{"name":"Create new Workflow Draft","id":"b0e03106-8ebc-4230-ae90-548288bebc3f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Test\",\n \"format\": \"order\",\n \"code\": \"o_test\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.factoryfour.com/workflows/drafts","auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":true,"source":{"_postman_id":"4f6834ef-0fa5-4ebb-b727-cd86600cf758","id":"4f6834ef-0fa5-4ebb-b727-cd86600cf758","name":"FactoryFour API","type":"folder"}},"urlObject":{"path":["workflows","drafts"],"host":["https://api.factoryfour.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b0e03106-8ebc-4230-ae90-548288bebc3f"},{"name":"Get Single Workflow Draft","id":"80fe6593-de05-45b3-b2f2-99936c4585e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.factoryfour.com/workflows/drafts/5ede59c5388f5e000cd805e9","auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":true,"source":{"_postman_id":"4f6834ef-0fa5-4ebb-b727-cd86600cf758","id":"4f6834ef-0fa5-4ebb-b727-cd86600cf758","name":"FactoryFour API","type":"folder"}},"urlObject":{"path":["workflows","drafts","5ede59c5388f5e000cd805e9"],"host":["https://api.factoryfour.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"80fe6593-de05-45b3-b2f2-99936c4585e1"},{"name":"Update Workflow Draft","id":"30fcadd5-5011-4a6a-8ff8-776f7f351d48","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n\t\"tasks\": [{\n\t\t\"key\": \"1\",\n\t\t\"code\": \"t_kitting\",\n\t\t\"dependsOn\": [\"start\"]\n\t}, {\n\t\t\"key\": \"2\",\n\t\t\"code\": \"t_prebake_test\",\n\t\t\"dependsOn\": [\"1\"]\n\t}, {\n\t\t\"key\": \"3\",\n\t\t\"code\": \"t_prebake_test_disposition\",\n\t\t\"dependsOn\": [\"2\"]\n\t}, {\n\t\t\"key\": \"end\",\n\t\t\"code\": \"end\",\n\t\t\"dependsOn\": [\"3\"]\n\t}]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.factoryfour.com/workflows/drafts/5ede59c5388f5e000cd805e9","auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":true,"source":{"_postman_id":"4f6834ef-0fa5-4ebb-b727-cd86600cf758","id":"4f6834ef-0fa5-4ebb-b727-cd86600cf758","name":"FactoryFour API","type":"folder"}},"urlObject":{"path":["workflows","drafts","5ede59c5388f5e000cd805e9"],"host":["https://api.factoryfour.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"30fcadd5-5011-4a6a-8ff8-776f7f351d48"},{"name":"Update Workflow Draft Complex","id":"c152621c-cd1c-4606-b6e8-aab73c153eec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n\t\"tasks\": [{\n\t\t\"key\": \"1\",\n\t\t\"code\": \"t_kitting\",\n\t\t\"dependsOn\": [\"start\"]\n\t}, {\n\t\t\"key\": \"2\",\n\t\t\"code\": \"t_prebake_test\",\n\t\t\"dependsOn\": [\"1\"]\n\t}, {\n\t\t\"key\": \"3\",\n\t\t\"name\": \"Prebake 1\",\n\t\t\"code\": \"t_prebake_test_disposition\",\n\t\t\"dependsOn\": [\"2\"]\n\t}, {\n\t\t\"key\": \"4\",\n\t\t\"name\": \"Prebake 2\",\n\t\t\"code\": \"t_prebake_test_disposition\",\n\t\t\"dependsOn\": [\"2\"]\n\t}, {\n\t\t\"key\": \"5\",\n\t\t\"code\": \"t_kitting\",\n\t\t\"dependsOn\": [\"3\", \"4\"]\n\t}, {\n\t\t\"key\": \"end\",\n\t\t\"code\": \"end\",\n\t\t\"dependsOn\": [\"5\"]\n\t}]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.factoryfour.com/workflows/drafts/5ede59c5388f5e000cd805e9","auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":true,"source":{"_postman_id":"4f6834ef-0fa5-4ebb-b727-cd86600cf758","id":"4f6834ef-0fa5-4ebb-b727-cd86600cf758","name":"FactoryFour API","type":"folder"}},"urlObject":{"path":["workflows","drafts","5ede59c5388f5e000cd805e9"],"host":["https://api.factoryfour.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c152621c-cd1c-4606-b6e8-aab73c153eec"},{"name":"Create revision of workflow draft","id":"a73a4b69-78a9-4152-8a43-f09a556cec82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.factoryfour.com/workflows/drafts/5ede59c5388f5e000cd805e9/revision","auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":true,"source":{"_postman_id":"4f6834ef-0fa5-4ebb-b727-cd86600cf758","id":"4f6834ef-0fa5-4ebb-b727-cd86600cf758","name":"FactoryFour API","type":"folder"}},"urlObject":{"path":["workflows","drafts","5ede59c5388f5e000cd805e9","revision"],"host":["https://api.factoryfour.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a73a4b69-78a9-4152-8a43-f09a556cec82"}],"id":"7c086c62-8cff-49e6-b408-a893439d2eca","_postman_id":"7c086c62-8cff-49e6-b408-a893439d2eca","description":"","auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":true,"source":{"_postman_id":"4f6834ef-0fa5-4ebb-b727-cd86600cf758","id":"4f6834ef-0fa5-4ebb-b727-cd86600cf758","name":"FactoryFour API","type":"folder"}}}],"id":"4f6834ef-0fa5-4ebb-b727-cd86600cf758","description":"

The FactoryFour API uses Bearer authentication for all requests. This folder of requests (FactoryFour API) is preconfigured to generate tokens using a Pre-Request script that is configured with environment variables specifying username and password. It also references authorization parameters in the collection folder such as authUrl and clientId.

\n","auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"eaed43e0-7e98-45d1-9027-00c1c11651f2","type":"text/javascript","exec":["const currentUsername = pm.globals.get(\"current_username\");","const sameUser = currentUsername === pm.variables.get(\"username\");","const currentConnection = pm.globals.get(\"current_connection\");","const sameConnection = currentConnection === pm.variables.get(\"connection\");","const currentToken = pm.globals.get(\"token\");","let tokenValid = false;","","if (sameUser) {"," console.log('Same user name is being used');","}","","if (sameConnection) {"," console.log('Same connection is being used');","}","","if (currentToken) {"," const payload = JSON.parse(atob(currentToken.split('.')[1]));"," tokenValid = (payload.exp - Math.floor(Date.now()/1000)) > 0","}","","if (tokenValid) {"," console.log('Token is valid!');","}","","if (!sameUser || !sameConnection || !tokenValid) {"," pm.sendRequest({"," url: pm.variables.get(\"auth0_url\") + '/oauth/token',"," method: 'POST',"," header:'content-type:application/json',"," body: {"," mode: 'raw',"," raw: JSON.stringify({"," username: pm.variables.get(\"username\"),"," password: pm.variables.get(\"password\"),"," grant_type: 'password',"," scope: 'openid email',"," connection: pm.variables.get(\"auth0_connection\"),"," client_id: pm.variables.get(\"auth0_client\")"," })"," }"," }, function (err, res) {"," if (err) {"," throw new Error(err);"," }"," pm.globals.set(\"current_username\", pm.variables.get(\"username\"));"," pm.globals.set(\"current_connection\", pm.variables.get(\"connection\"));"," pm.globals.set(\"token\", res.json().id_token);"," });","}",""]}},{"listen":"test","script":{"id":"a46c429b-0afe-44db-9d3e-c8d7892f553a","type":"text/javascript","exec":[""]}}],"_postman_id":"4f6834ef-0fa5-4ebb-b727-cd86600cf758"}],"event":[{"listen":"prerequest","script":{"id":"a6c0e709-eef2-4734-909b-83495140b724","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ad116502-6a72-4675-a1e8-78668af47ae5","type":"text/javascript","exec":[""]}}],"variable":[{"key":"auth0_url","value":"https://auth.factoryfour.com"},{"key":"auth0_client","value":"EROxMPqTUoZE21q6xD6CDnPLt2maGy6o"},{"key":"auth0_connection","value":"FactoryFour-Production"},{"key":"url_base","value":"https://api.factoryfour.com"}]}