{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"5b61ba25-94c4-44ea-9567-5e43ca0f7d20","name":"API Integração","description":"### INTRODUÇÃO\n\nA fim de melhorar a automatização do processo de atendimento ao cliente e garantir o sucesso da operação, o sistema **VocallContact** disponibiliza integrações dinâmicas.\n\nAqui está o escopo e especificação da API RESTful de integração VocallContact. A metodologia utilizada é **REST** e significa Representational State Transfer. Em português, Transferência de Estado Representacional. Trata-se de uma abstração da arquitetura da Web. Resumidamente, o REST consiste em princípios/regras/constraints que, quando seguidas, permitem a criação de um projeto com interfaces bem definidas. Desta forma, permitindo, por exemplo, que aplicações se comuniquem.\n\nA integração disponibiliza a manutenção completa dos cadastros de Empresas, Contatos, Vendedores, Pedidos, Notas Fiscais e Faturas (Duplicatas) dentro da ferramenta **VocallContact**, onde é possível criar, ler, alterar e excluir registros de todas as entidades.\n\n### AUTENTICAÇÃO\n\nCada cliente do VocallContact tem um usuário e uma chave única (_token_) para acesso aos métodos da API, esta chave será fornecida no início do contrato.\n\n### TIPOS DE DADOS\n\nPara os campos das entidades, temos os seguintes tipos mapeados:\n\n- **Texto / Alfanumérico -** Campo alfanumérico permitindo letras, números e pontuação\n \n- **Numero Inteiro / INT -** Campo numérico permitindo apenas números.\n \n- **Email -** Campo no formato [suporte@eox.com.br](https://mailto:suporte@eox.com.br)\n \n- **Data -** Data no formato YYYY-MM-DD.\n \n- **Decimal / Valor -** Campo no formato decimal no formato 999999.99 ( Utilizar . Ponto )\n \n- **Telefone -** Campo no formato DDD 912345678\n \n\n## INFORMAÇÕES DOS CAMPOS\n\n**Adicione / {nome_entidade} /info** no final da URL e sera retornado todos os campos da tabela solicitada,\n\nEX: [https://api-integracao.vocallcontact.com.br/v1/empresa/info](https://api-integracao.vocallcontact.com.br/v1/empresa/info)\n\nVocê pode trocar a entidade empresa, por qualquer outra entidade.\n\n### RESPOSTAS DA API\n\nTodas as respostas de sucesso retornan o mesmo modelo, a diferença esta no retorno dos erros\n\n- Retorno de sucesso \n Retorna o total de requisições recebidas\n \n\n\n\nRetorno de erros \nos erros são detalhados na resposta\n\n\n\n- Resposta tipo string \n Adicione o parametro no header Return = detail-string\n \n\n\"Parametro\"\n\nResposta de sucesso \nRetorno com o total de requisições recebidas\n\n\n\nResposta de erro \nRetorna os erros dentro de strings separadas\n\n\n\n- Resposta tipo resume\n \n\nAdicione o parametro no header Return = resume\n\n\"Parametro\"\n\nResposta de sucesso \nRetorno com o total de requisições recebidas\n\n\n\nResposta de erro \nNão será retornado o local especifico do erro, somente a quantidade de requisições recebidas e a quantidade de erros\n\n\n\n### MAXIMO DE REQUISIÇÕES\n\n- As requisições são limitadas em 1000 nós (POST, PUT e PATCH)\n \n- EX: pode ser enviado ate mil empresas, ou 500 empresas e 500 contatos\n \n\n### CARACTERES ESPECIAIS NÃO PERMITIDOS\n\nPara evitar qualquer tipo de problema não é permitido o uso de caracteres especiais, principalmente nos campos que são tratados como chave primaria ou chave única, como por exemplo o campo codigo_empresa.\n\nNÃO SÃO PERMITIDOS O USO DOS SEGUINTES CARACTERES\n\n\\# \\\\ / : ; ? % & $ \" ' ´ \\` \\* + = § ( ) { } \\[ \\] º ª ! \\~ ^ | < >","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"33093380","collectionId":"5b61ba25-94c4-44ea-9567-5e43ca0f7d20","publishedId":"2sA3JKdMqb","public":true,"publicUrl":"https://documenter-api.postman.tech/view/33093380/2sA3JKdMqb","privateUrl":"https://go.postman.co/documentation/33093380-5b61ba25-94c4-44ea-9567-5e43ca0f7d20","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":"API CRM VocallContact"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-05-08T19:33:40.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"API CRM VocallContact","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"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/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":""},"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"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sA3JKdMqb"}