You can use Ontic's REST APIs to extend our system capabilities. Using Ontic's APIs you can perform different actions and subscribe to updates.
\nAuthentication & Authorization (Using OAuth 2.0) the section.HOST variable in Postman. You can specify the HOST variable for production or stage/sandbox, based on your requirement.You can directly import the APIs into your postman using the Run in Postman button in the top right corner. The Ontic.ai APIs postman collection depends upon some environment variables defined below. Please make sure you create those variables before testing the APIs
This value shoulf be fixed: client_credentials
This will be provided to you on application registeration
\n"},{"key":"client_secret","value":"{{OAUTH_CLIENT_SECRET}}","type":"text","description":"This will be provided to you on application registeration
\n"}]},"url":"https://{{HOST}}/auth/oauth/token","description":"This is the start of the oauth flow. You will be redirecting your user to this request to start oauth flow.
\n","urlObject":{"protocol":"https","path":["auth","oauth","token"],"host":["{{HOST}}"],"query":[],"variable":[]}},"response":[{"id":"26688df0-dd2f-4428-a04e-ac1e6d316555","name":"1. Generate Refresh & Access Token","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","type":"text","description":"This value shoulf be fixed: `client_credentials`"},{"key":"client_id","value":"{{OAUTH_CLIENT_ID}}","type":"text","description":"This will be provided to you on application registeration"},{"key":"client_secret","value":"{{OAUTH_CLIENT_SECRET}}","type":"text","description":"This will be provided to you on application registeration"}]},"url":"https://{{HOST}}/auth/oauth/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jul 2022 06:20:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"strict-transport-security","value":"max-age=31536000 ; includeSubDomains"},{"key":"x-frame-options","value":"DENY"},{"key":"vary","value":"Accept-Encoding, User-Agent"},{"key":"Content-Encoding","value":"gzip"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"72663beeee0e5803-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \".................eyJzdWIiOiJhdXnQG9udG...xMTRmNTY2NDA0OWY2yMTR.......DQsImpfVV9JIjoGIwYjVlM......jIiLCJMjIyODR9.iIIqm4dt8VA_3DN....\",\n \"refresh_token\": \"....e3cd707805......\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 2591999\n}"}],"_postman_id":"d6cf7a25-b5c6-41d5-85d2-6b8a76b44143"}],"id":"203727bc-d399-460c-882d-14b992aea521","_postman_id":"203727bc-d399-460c-882d-14b992aea521","description":""},{"name":"Refresh Access Token","id":"8770e5b1-f2e4-47bd-a33a-4a95768b4951","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"{{OAUTH_CLIENT_ID}}","description":"It will be provided to you on the application registeration
\n","type":"text"},{"key":"client_secret","value":"{{OAUTH_CLIENT_SECRET}}","description":"It will be provided to you on the application registeration
\n","type":"text"},{"key":"grant_type","value":"refresh_token","description":"This should be fixed value: refresh_token
You will get it from the response of the Generate Access & Refresh Token request
Access token are only valid for specific time. Use this to refresh your current access to get a new access token.
\n","urlObject":{"protocol":"https","path":["auth","oauth","token"],"host":["{{HOST}}"],"query":[],"variable":[]}},"response":[{"id":"56b775d2-6dbb-446c-99c7-a7b0894766c4","name":"4. Refresh Access Token","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"{{OAUTH_CLIENT_ID}}","description":"It will be provided to you on the application registeration","type":"text"},{"key":"client_secret","value":"{{OAUTH_CLIENT_SECRET}}","description":"It will be provided to you on the application registeration","type":"text"},{"key":"grant_type","value":"refresh_token","description":"This should be fixed value: `refresh_token`","type":"text"},{"key":"refresh_token","value":"{{OAUTH_REFRESH_TOKEN}}","description":"You will get it from the response of the `Generate Access & Refresh Token` request","type":"text"}]},"url":"https://{{HOST}}/auth/oauth/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Jun 2022 02:42:42 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"set-cookie","value":"AWSALBTG=w5Gww4U2VTfmeCHScr1sbp1/d1ybVXGi9WY6SKPfdkWfUu9l7lkqU+jT6NcGGXPQakvs/8ter6XQwyFOwDJWImt8Wii9Tk1JCznNe4E1ilTZUVqW2OlyJWpQzMH95julvu7IqtbF02M6997brpQenGRj0eyCJcqM02SgM0f/h+wKOhREs34=; Expires=Mon, 04 Jul 2022 02:42:42 GMT; Path=/"},{"key":"set-cookie","value":"AWSALBTGCORS=w5Gww4U2VTfmeCHScr1sbp1/d1ybVXGi9WY6SKPfdkWfUu9l7lkqU+jT6NcGGXPQakvs/8ter6XQwyFOwDJWImt8Wii9Tk1JCznNe4E1ilTZUVqW2OlyJWpQzMH95julvu7IqtbF02M6997brpQenGRj0eyCJcqM02SgM0f/h+wKOhREs34=; Expires=Mon, 04 Jul 2022 02:42:42 GMT; Path=/; SameSite=None; Secure"},{"key":"set-cookie","value":"AWSALB=wRCNVRJB/3VG2ekNQegdtwUu4LFAozygYSUhGTf4txPEGXobk2diTLsoy7wMv3o2eouds88ywfBWd5c2wuyVD8njpqF+IAI81J5CyRHWMXr8GYe9E0MDElraQIpq; Expires=Mon, 04 Jul 2022 02:42:42 GMT; Path=/"},{"key":"set-cookie","value":"AWSALBCORS=wRCNVRJB/3VG2ekNQegdtwUu4LFAozygYSUhGTf4txPEGXobk2diTLsoy7wMv3o2eouds88ywfBWd5c2wuyVD8njpqF+IAI81J5CyRHWMXr8GYe9E0MDElraQIpq; Expires=Mon, 04 Jul 2022 02:42:42 GMT; Path=/; SameSite=None; Secure"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"strict-transport-security","value":"max-age=31536000 ; includeSubDomains"},{"key":"x-frame-options","value":"DENY"},{"key":"vary","value":"Accept-Encoding, User-Agent"},{"key":"Content-Encoding","value":"gzip"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"721ad4b7dcb75da3-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"eyJ...MiJ9.eyJzdWIiOiJyamFr...1OTh9.i5...KMhAO10T_UUyA...\",\n \"refresh_token\": \"...b001a66a9f8d...\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 2591999\n}"}],"_postman_id":"8770e5b1-f2e4-47bd-a33a-4a95768b4951"},{"name":"Test Resource Access","id":"ed1e3582-5c88-45ec-b66a-71c78aab5d27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{OAUTH_ACCESS_TOKEN}}"},"isInherited":false},"method":"GET","header":[],"url":"https://{{HOST}}/rest/api/{{API_VERSION}}/integration/test-auth","urlObject":{"protocol":"https","path":["rest","api","{{API_VERSION}}","integration","test-auth"],"host":["{{HOST}}"],"query":[],"variable":[]}},"response":[{"id":"93bba3ec-1ae3-4b0d-b940-cdddc4df9fae","name":"5. Test Resource Access","originalRequest":{"method":"GET","header":[],"url":"https://{{HOST}}/rest/api/v1/integration/test-auth"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Jun 2022 02:44:10 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"set-cookie","value":"AWSALBTG=vIynWe+2y8fNzmsdArPI3qxZxv4qR/E+okWWgAEJ8ND0Yx/Rrjd/pB9ojFLgxJ4GUFXOhQhy2cAsQpJZXi7FEHtefA+O6sXSHbLx9Nwb2+H8Dj/24n1E1CmvJGFHQXrYSZ+ciEJp3DUAq20euMB3v7Flmz8NsBu1EQfp/rb3hsoVmdnhgSGwbn0oafGNPHuDeeUrVwv7uVsfJfK/sXUUlq4CGOVEUlKsD0H+I0rreL+BfGDwl3UwmXDAEhK2hdUKLbOp7yA=; Expires=Mon, 04 Jul 2022 02:44:10 GMT; Path=/"},{"key":"set-cookie","value":"AWSALBTGCORS=vIynWe+2y8fNzmsdArPI3qxZxv4qR/E+okWWgAEJ8ND0Yx/Rrjd/pB9ojFLgxJ4GUFXOhQhy2cAsQpJZXi7FEHtefA+O6sXSHbLx9Nwb2+H8Dj/24n1E1CmvJGFHQXrYSZ+ciEJp3DUAq20euMB3v7Flmz8NsBu1EQfp/rb3hsoVmdnhgSGwbn0oafGNPHuDeeUrVwv7uVsfJfK/sXUUlq4CGOVEUlKsD0H+I0rreL+BfGDwl3UwmXDAEhK2hdUKLbOp7yA=; Expires=Mon, 04 Jul 2022 02:44:10 GMT; Path=/; SameSite=None; Secure"},{"key":"set-cookie","value":"AWSALB=CjDp8Jzgup6FKUmwOfIPgrsPCfsRsZK0rSDGO65AxU6fs4y3ZWd7Rvx9VW/Ha9H90tqKkU6eR8xanNU435xo0cAhKJhfTOH5oz8mFiJIVqrUXawAENDF15s6x0EC; Expires=Mon, 04 Jul 2022 02:44:10 GMT; Path=/"},{"key":"set-cookie","value":"AWSALBCORS=CjDp8Jzgup6FKUmwOfIPgrsPCfsRsZK0rSDGO65AxU6fs4y3ZWd7Rvx9VW/Ha9H90tqKkU6eR8xanNU435xo0cAhKJhfTOH5oz8mFiJIVqrUXawAENDF15s6x0EC; Expires=Mon, 04 Jul 2022 02:44:10 GMT; Path=/; SameSite=None; Secure"},{"key":"reqid","value":"62b9197ad3a3a70bec288e38"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"strict-transport-security","value":"max-age=31536000 ; includeSubDomains"},{"key":"x-frame-options","value":"DENY"},{"key":"vary","value":"Accept-Encoding, User-Agent"},{"key":"Content-Encoding","value":"gzip"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"721ad6da6eb38f1d-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"org_name\": \"ORGANIZATION NAME\",\n \"user_id\": \".......165......9a930c..\",\n \"org_id\": \"....ff8a4f5528......21fc\",\n \"user_name\": \"SAMPLE_USERNAME\"\n}"}],"_postman_id":"ed1e3582-5c88-45ec-b66a-71c78aab5d27"}],"id":"6f42e830-ebc3-45e0-8238-9827ed6af3de","_postman_id":"6f42e830-ebc3-45e0-8238-9827ed6af3de","description":""}],"id":"9dd3f069-0ac2-4feb-9d84-b12d0354652c","description":"Ontic.ai support OAuth 2.0 protocol for authentication and authorization. The process has following steps:
\nRegister your oauth application with Ontic.ai and collect client_id and client_secret.
\nUse the credentials provided in above step to set up OAUTH flow and collect authorization_grant
\nUse authorization_grant to collect access_token and refresh_token
\nTo register the application please share following with your Ontic.ai POC:
\nCompany Name
\nCompany Email Address
\nOAuth Redirect URL (REDIRECT_URI)
\nAfter the Registration, following credentials will be shared with you:
\nOAuth Client Id for stage/sandbox environment
\nOAuth Client Secret for stage/sandbox environment
\nThe OAuth flow works as following:
\nYou will have to redirect the user to Ontic (along with the credentials) to start the oauth process.
\nUser approves the request: User will be redirected to the REDIRECT_URI along with the Authorization Grant Code.
User rejects the request: User will be redirected to the REDIRECT_URI along with the error details/info.
\n\n\nPlease refer to the requests provided below to see the technical details for these requests/api calls. All these requests also contains a complete example.
\n
Use the Authorization Grant Code along with the application credentials to fetch the Access Token and Refresh Token.
The access token is only valid for a specific time, after that you will need to refresh it using the refresh token.
\n\n\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"1475943c-735a-492d-9577-0a0b10c54cd2"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"6e6e0ade-fc10-4477-bc1a-91b44ca7eddf"}}],"_postman_id":"9dd3f069-0ac2-4feb-9d84-b12d0354652c"},{"name":"Asset APIs","item":[{"name":"Get Asset Field Definition","id":"1640247b-765f-46c9-8dd0-beb36469d7b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{OAUTH_ACCESS_TOKEN}}"},"isInherited":false},"method":"GET","header":[],"url":"https://{{HOST}}/rest/api/{{API_VERSION}}/integration/Please refer to the requests provided below to see the technical details for these requests/api calls. All these requests also contains a complete example.
\n
To fetch entity fields dynamically for authenticated account.
\nThe request can also be coupled with certain OPTIONAL query parameters that give specific responses. These parameters are OPTIONAL and request will work without them. These OPTIONAL parameters are:
\nThe requestField key can take one of the three actions as values which are NOT CASE SENSITIVE. These actions are mentioned below:
\n1. CREATE: This is the request field that returns all the fields that can be created/added for the provided asset_type and asset_subtype. (This is the default request field in case no Request field is mentioned)
\n2. UPDATE: This is the request field that returns all the fields that can be updated for the provided asset_type and asset_subtype.
\n3. SEARCH: This is the request field that returns all the fields that are searchable for the provided asset_type and asset_subtype.
\nThe fieldIds key can take the field Ids of the Field Definitions as values and return Field Definitions for only those ids.
\nNOTE: fieldIds can take single or multiple field ids. Multiple field ids must be COMMA(,) separated WITHOUT SPACE. See examples for reference.
\nThe response will be of format mentioned below. Please refer to the example to see a complete response.
\n{\n \"key\": \"Fields\",\n \"data\": [\n {FieldDefinition Object},\n {FieldDefinition Object}\n ],\n \"count\": 37\n\nThis defined the data type of the field. All the possible values are:
\nThis defines the type of the field.
\nSingle Value: Defines if whether only single value will be expected as the field value
Predefined Values: Defines if the options have pre-defined values or custom values