{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"268fb1f3-281c-486a-af20-98eec57ffccd","name":"MUB - Documentação API  Integration (versão 1.5)","description":"# Visão Geral\n\nNessa documentação, você encontrará informações em relação à comunicação com a nossa API, que tem por objetivo auxiliar a integração entre o mub e a grande maioria dos sistemas. A nossa API é o único modo para acesso autorizado aos dados do mub e é onde toda a integração acontece. Ela é uma API baseada nos princípios REST e todos os dados são enviados e recebidos como JSON.\n\nQualquer dúvida que surgir durante a implementação, estamos à disposição através do e-mail: [infra@mub.one](https://infra@mub.one) ou nosso site [www.mymub.com.br](https://www.mymub.com.br). Sugestões e feedbacks de melhorias, também são bem vindas!\n\n# Tabela de atualizações\n\n| **Versão** | **Descrição das alterações** |\n| --- | --- |\n| 1.5 | Adicionado seção \"Fields\" que permite buscar os campos adicionais e suas opções diretamente através da API |\n| 1.6 | Adicionado versionamento no disparo de um webhook, por processo, configurável no cadastro do Processo -> Aba Config. Avançada -> Versão da API |\n\n# Endpoint\n\nO endpoint de conexão com a API REST JSON do mub é: [https://apiv2.mub.cloud/api/v2](https://api.mub.cloud/api/v2) para o ambiente de homologação e [https://apiv2.mub.one/api/v2](https://apiv2.mub.one/api/v2) para ambiente de produção.\n\n# Rotas / Recursos disponíveis\n\nNo menu lateral esquerdo, é apresentado os métodos atualmente disponíveis na API.\n\n# Autenticação\n\nPara ser possível trabalhar com os métodos da API, é necessário que a autenticação seja feita através de uma API KEY, que é um token único que irá identificar a empresa (conta) no mub.\n\nPara ter acesso ao Token API de integração REST é só acessá-lo através do seguinte caminho abaixo:  \nPlataforma mub > Ajustes > Instâncias > Token API e então enviá-la codificada no cabeçalho das requisições (header).\n\nO token deve ser enviado através do header no seguinte formato:\n\n`{key}: {value}`\n\nObservação: Todas as requisições da API devem ser feitas por HTTPS. As requisições sem autenticação ou feitas por “HTTP simples”, irão falhar.\n\n# Códigos de erros\n\nA API retorna o código 200 caso a solicitação tenha sido resolvida com sucesso, e 500 caso algum erro tenha acontecido, seguido de uma mensagem de erro no corpo da requisição. Exemplo:\n\n``` json\n{\n    \"success\": false,\n    \"message\": [\n        [ \"Register [29811111] not found.\" ]\n    ]\n}\n\n ```\n\n# Tabela de versões do webhook\n\nPara garantir a compatibilidade do webhook com implementações anteriores, o disparo de webhook é versionado, podendo ser modificado a versão dentro do cadastro de processo, indo em:\n\nAjustes do sistema > Seção \"Workflow\" > Menu \"Processos\" > Editar um processo > Aba \"Config. Avançada\" > Campo \"Versão da API\"\n\n| **Versão** | **Descrição das alterações** |\n| --- | --- |\n| 1.0.0 | Versão clássica da API |\n| 1.0.1 | Campo do tipo telefone passa a ser disparado com o valor incompleto, removendo caso inicie com +xx, exemplo:  <br>  <br>Número brasileiro: \"54 99936-8153\"  <br>Número americano: \"201-555-2033\"  <br>  <br>Nas demais versões, nos exemplos acima, seria enviado no seguinte formato caso especificado de forma completa pelo usuário:  <br>Número brasileiro: \"+55 54 99936-8153\"  <br>Número americano: \"+1 201-555-2033\" |\n| 2.0.0 | Campo adicional do tipo monetário passa a disparar no seguinte formato:  <br>{ \"currency\": \"R$\", \"value\": 123.12 }  <br>Ao invés do formato anterior onde somente o valor era retornado |\n\n# Tabela de Status\n\n| **Código** | **Descrição** |\n| --- | --- |\n| C | Em criação |\n| A | Ativo |\n| I | Inativo |\n\n# **Tabela de descrições**\n\n| **Código** | **Descrição** |\n| --- | --- |\n| LONG_DESCRIPTION | Descrição longa |\n| SHORT_DESCRIPTION | Descrição curta |\n| CUSTOM_DESCRIPTION | Descrição customizada pelo cliente |\n\n# Tabela de Idiomas\n\n| **Código** | **Descrição** |\n| --- | --- |\n| af | Afrikaans |\n| ar | Arabic |\n| ca | Catalan |\n| az | Azeri (Latin) |\n| az-AZ | Azeri (Cyrillic) |\n| be | Belarusian |\n| bg | Bulgarian |\n| bs-BA | Bosnian |\n| cs | Czech |\n| cy | Welsh |\n| da | Danish |\n| de | German |\n| dv | Divehi |\n| el | Greek |\n| en | English |\n| en-US | English (United States) |\n| eo | Esperanto |\n| es | Español |\n| et | Estonian |\n| eu | Basque |\n| fa | Farsi |\n| fi | Finnish |\n| fo | Faroese |\n| fr | French |\n| gl | Galician |\n| gu | Gujarati |\n| he | Hebrew |\n| hi | Hindi |\n| hr | Croatian |\n| hu | Hungarian |\n| hy | Armenian |\n| id | Indonesian |\n| is | Icelandic |\n| it | Italian |\n| ja | Japanese |\n| ka | Georgian |\n| kk | Kazakh |\n| kn | Kannada |\n| ko | Korean |\n| kok | Konkani |\n| ky | Kyrgyz |\n| lt | Lithuanian |\n| lv | Latvian |\n| mi | Maori |\n| mk | FYRO Macedonian |\n| mn | Mongolian |\n| mr | Marathi |\n| ms | Malay |\n| mt | Maltese |\n| nb | Norwegian |\n| nl | Dutch |\n| nn-NO | Norwegian (Nynorsk) |\n| ns | Northern Sotho |\n| pa | Punjabi |\n| pl | Polish |\n| ps | Pashto |\n| pt-br | Portuguese (Brazil) |\n| pt-PT | Portuguese (Portugal) |\n| qu | Quechua |\n| ro | Romanian |\n| ru | Russian |\n| sa | Sanskrit |\n| se | Sami |\n| sk | Slovak |\n| sl | Slovenian |\n| sq | Albanian |\n| sr-BA | Serbian (Latin) |\n| sr-BA | Serbian (Cyrillic) |\n| sv | Swedish |\n| sw | Swahili |\n| syr | Syriac |\n| ta | Tamil |\n| te | Telugu |\n| th | Thai |\n| tl | Tagalog |\n| tn | Tswana |\n| tr | Turkish |\n| tt | Tatar |\n| ts | Tsonga |\n| uk | Ukrainian |\n| ur | Urdu |\n| uz | Uzbek (Latin) |\n| uz-UZ | Uzbek (Cyrillic) |\n| vi | Vietnamese |\n| xh | Xhosa |\n| zh-CN | Chinese (Simplified) |\n| zh-TW | Chinese (Traditional) |\n| zu | Zulu |\n\n# Tabela de tipos - campos adicionais\n\n| **Tipo** | **Descrição** |\n| --- | --- |\n| TEXT | Texto |\n| LONG_TEXT | Texto longo |\n| LIST_SINGLE | Lista opção única |\n| LIST_MULTIPLE | Lista opção múltipla |\n| EMAIL | E-mail |\n| HOUR | Hora |\n| CURR | Monetário |\n| NUM | Numérico |\n| URL | URL |\n| DATE | Data |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"17759447","team":3573146,"collectionId":"268fb1f3-281c-486a-af20-98eec57ffccd","publishedId":"UVJfhuPk","public":true,"publicUrl":"https://documenter-api.postman.tech/view/17759447/UVJfhuPk","privateUrl":"https://go.postman.co/documentation/17759447-268fb1f3-281c-486a-af20-98eec57ffccd","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"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":"EF5B25"}}]}},"version":"8.12.5","publishDate":"2023-10-23T15:36:42.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Production","id":"3971f0f7-4dbc-49d9-b280-eb6ee7902fdd","owner":"19113972","values":[{"key":"url","value":"https://apiv2.mub.one/api/v2","enabled":true,"type":"default"},{"key":"apiKey","value":"teste","enabled":true,"type":"default"},{"key":"apiKeyValue","value":"teste","enabled":true,"type":"default"},{"key":"apiKeyBI","value":"teste","enabled":true,"type":"default"},{"key":"apiKeyBIValue","value":"teste","enabled":true,"type":"default"}],"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/417b95dd0751e6f1b57a7efbfcfb601f2a771516726d495f88e0aada2180f19d","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"},{"label":"Production","value":"19113972-3971f0f7-4dbc-49d9-b280-eb6ee7902fdd"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/UVJfhuPk"}