{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"52f18995-91c1-4551-912e-76de34a21e50","name":"Insigna API - Integration","description":"## Introdução\n\nWelcome to the Insigna Consultoria API documentation.\n\nOur API is implemented in the REST model. Through this interface, it is possible to chat with the Insigna system, commanding actions, verifying configurations and performing synchronization with their systems.\n\n> The base communication address is `{{url}}`, always accompanied by the secure protocol https: // as a prefix. \n  \n\n---\n\n#### Authorization\n\nAuthentication at Insigna is done using an API key. This key is for the system to identify your account, and authorize communication between systems.\n\n> Make sure to use the following header in your requests: \n  \n\n```\nAuthorization: Bearer ACCESS_TOKEN\n\n```\n\n> &lt;h6 &gt;Treat your API keys like passwords!&lt;/h6&gt; \n  \n> Do not include your API key publicly anywhere on your website or javascript. Remember that this key gives you access to your data at Insigna. \n  \n\n###### How to get my Access Key\n\nIt can be managed through the Insigna system, as follows:\n\n> Home > Account > Lists \n  \n\nor via the link:\n\n[https://app.insignaconsultoria.com.br/account](https://app.insignaconsultoria.com.br/account)\n\nNext, select the desired account and click on the Integration tab. Now you can manage your keys as well as your webhooks.\n\n<img src=\"https://tostorageprod.blob.core.windows.net/public/tutorial_criar_access_key.gif\" alt=\"\">\n\n###### Webhooks\n\nBelow are the available events:\n\n- **created** (when solicitation is created);\n- **started** (when user started solicitation test);\n- **resumed** (when user resumed solicitation test);\n- **finished** (when user finished solicitation test);\n- **corrected** (when insigna consultant corrects the solicitation test);\n- **done** (when insigna consultant delivery result solicitation test, then report's url is available);\n    \n\n**Life Cycle**\n\n<img src=\"https://tostorageprod.blob.core.windows.net/public/flow_assessment.png?q=1\" alt=\"\">\n\n**Payload event**\n\nEvents will receive the following payload:\n\n``` json\n{\n  \"payload\": {\n    \"solicitation_id\": 242773,\n    \"user_id\": 12345\n  },\n  \"timestamp\": 1648066040,\n  \"event\": \"done\"\n}\n\n```\n\n---\n\n#### Requests\n\nAll requests must be made using the HTTPS protocol, so that the information is encrypted. When the request is made, a response is returned in JSON format.\n\nAPI's REST allows verbs to be used, which will be briefly described below:\n\n- `GET` - used for information. The requested information will be returned through a JSON object.\n- `POST` - used to add a new resource, it must contain all the necessary attributes for the creation of a new object. The return of this verb will be through a JSON object.\n- `PUT` - must be used to update / replace an existing resource. The attributes that must be updated / replaced must be informed.\n- `DELETE` - used to remove a resource. For such action to be performed, the informed resource must exist otherwise an error message will be returned indicating that the resource was not found.\n    \n\n#### Responses\n\nIn order to facilitate interoperability between systems, all endpoints in our API respond in JSON format.\n\n> Return example: \n  \n\n``` json\n{\n  \"data\": [\n    {\n      //your data...\n    },\n    {\n      //your data...\n    }\n    //...\n  ]\n}\n\n```\n\n#### Errors\n\nThe API uses the HTTP Status Codes themselves to indicate success or failure in the request. In general, codes starting with `2` indicate _\\* success_ _**, those starting with**\\*_`4`\\* _indicate \\*_ error ** (Ex: Field validation failed) and starting with `5` indicate ** internal error \\* \\* on Insigna's servers.\n\nFormat for errors in status 400, 401 and 404\n\n``` json\n{\n  \"message\": \"Entity [1] not found.\"\n}\n\n```\n\nFormat for status 422 errors\n\n``` json\n{\n  \"message\": \"The given data was invalid.\",\n  \"errors\": {\n    \"name\": [\n      \"The name field is required.\"\n    ]\n    //...\n  }\n}\n\n```\n\n#### Pagination\n\nIn the pagination API's, we use two parameters to enable paging in your system, they are:\n\n`start`: Determines how many records at the beginning of your listing will be ignored.  \n`limit`: Determines the maximum number of records that will be returned.\n\n> Note: These parameters work even if they are not called simultaneously. \n  \n\nBelow is the structure of the objects returned when the API is paginated:\n\n``` json\n{\n  \"data\": [],\n  \"links\": {\n    \"first\": \"{{url}}/v1/integration/entity?page=1\",\n    \"last\": \"{{url}}/v1/integration/entity?page=1\",\n    \"prev\": null,\n    \"next\": null\n  },\n  \"meta\": {\n    \"current_page\": 1,\n    \"from\": null,\n    \"last_page\": 1,\n    \"links\": [\n      {\n        \"url\": null,\n        \"label\": \"« Previous\",\n        \"active\": false\n      },\n      {\n        \"url\": \"{{url}}/v1/integration/entity?page=1\",\n        \"label\": 1,\n        \"active\": true\n      },\n      {\n        \"url\": null,\n        \"label\": \"Next »\",\n        \"active\": false\n      }\n    ],\n    \"path\": \"{{url}}/v1/integration/entity\",\n    \"per_page\": 15,\n    \"to\": null,\n    \"total\": 0\n  }\n}\n\n```\n\n#### Rate Limits\n\nThe number of simultaneous API requests is 200 (two hundred) requests per minute. Upon exceeding this value, a 429 Too Many Requests response is returned, as shown below:\n\n``` json\n{\n  \"message\": \"Too many requests. Please try again in 60 seconds.\"\n}\n\n```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"14353547","team":2075767,"collectionId":"52f18995-91c1-4551-912e-76de34a21e50","publishedId":"UVeAw9eM","public":true,"publicUrl":"https://docs.insignaconsultoria.com.br","privateUrl":"https://go.postman.co/documentation/14353547-52f18995-91c1-4551-912e-76de34a21e50","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"007491"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.0","publishDate":"2022-02-22T14:11:44.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Insigna API - Integração Produção","id":"05d3354b-5327-486e-806d-436f1d2b19e9","owner":"14353547","values":[{"key":"url","value":"https://api.insignaconsultoria.com.br","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/9ef7b26966efe5b3bc11e3ab61ed62e78b986adba760bbb165c90593841f4bbd","favicon":"https://insignaconsultoria.com.br/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Insigna API - Integração Produção","value":"14353547-05d3354b-5327-486e-806d-436f1d2b19e9"}],"canonicalUrl":"https://docs.insignaconsultoria.com.br/view/metadata/UVeAw9eM"}