{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"d15fd15e-25c2-4e27-958a-2a1303f328c9","name":"Yungas: APIs e WebHooks","description":"API é o acrônimo de _application programming interface_, ou seja, a especificação da interface para integração entre sistemas. O objetivo de viabilizar integrações através de nossas APIs é oferecer a possibilidade de estender as funcionalidades da nossa plataforma, conectando ações realizadas na Yungas com outros sistemas e vice-versa.\n\nNesta página você irá encontrar as informações necessárias para realizar a integração.\n\n**Requisitos**\n\n- Para utilizar nossa API é necessário que você tenha familiaridade com a terminologia básica utilizada no desenvolvimento de web-services REST. Você poderá utilizar a linguagem de programação de sua escolha.\n    \n- Além do conhecimento técnico, é importante que você conheça a plataforma da Yungas do ponto de vista de um usuário comum. Em caso de dúvidas, consulte nosso time de Customer Success.\n    \n\n**Segurança e Autenticação**\n\n- A autenticação é realizada seguindo o padrão [OAuth 2.0](https://oauth.net/2/).\n    \n- O endpoint [/api/v3/public/oauth/token](https://staging.yungas.com.br/api/v3/public/oauth/token) deve ser utilizado para obter um Token, que será apresentado nas requisições subsequentes.\n    \n- Para obter suas credenciais de acesso, entre em contato com o nosso time de suporte (suporte@yungas.com.br).\n    \n- Múltiplas credenciais podem ser fornecidas para um mesmo cliente e cada credencial pode ter um escopo restrito; recomendamos fazer uso desta prática (gerar credenciais diferentes para cada fluxo de integração).\n    \n\n**Limites de requisições**\n\n- A plataforma possui um limite de 1000 requisições a cada 5 minutos\n    \n- Se exceder este limite, você receberá um erro HTTP 405\n    \n\n**Versionamento e manutenção**\n\n- A API v3 é atualmente suportada e está sendo evoluída\n    \n- Versões anteriores estão sendo **descontinuadas** e seu uso **não é recomendado**; como referência, aqui estão os links das respectivas documentações:\n    \n    - v1 - [https://app.yungas.com.br/static/docs/index.html](https://app.yungas.com.br/static/docs/index.html)\n        \n    - v2 - [https://app.yungas.com.br/apidocs/](https://app.yungas.com.br/apidocs/)\n        \n\n**Web Hooks**\n\n- Além da API REST, a plataforma Yungas também suporta a configuração de Web-Hooks.\n    \n- A documentação contempla o formato de retorno para cada um dos eventos suportados\n    \n- Para maiores informações sobre como configurá-lo em sua conta, consulte o time de Customer Success\n    \n\n**Ambientes**:\n\n- Temos dois ambientes disponíveis para interação com as APIs e WebHooks: _staging_ (preparo) e _production_ (o ambiente real, em produção)\n    \n- Em cada ambiente, existirão contas e chaves de acesso diferentes- pois toda a infra-estrutura é isolada.\n    \n- Production: [<b>https://app.yungas.com.br</b>](https://app.yungas.com.br)\n    \n    - Trata-se do ambiente real, em produção, onde os dados reais e interações reais acontecem entre os usuários de sua conta.\n        \n    - Recomendamos que utilize este ambiente após já ter maior familiaridade com a solução sendo desenvolvida, através de testes no ambiente de _staging._\n        \n- Staging: [<b>https://staging.yungas.com.br</b>](https://staging.yungas.com.br)\n    \n    - Trata-se de um ambiente de preparo, que pode ser utilizado em fase inicial do desenvolvimento da integração\n        \n    - Pode replicar aspectos necessários para o cenário de cada cliente\n        \n    - Pode receber correções ou ajustes necessários para viabilizar a integração com maior agilidade, se comparado com '_production_'.\n        \n    - Pode estar com uma versão de software mais avançada, em relação a _production_.\n        \n    - Pode apresentar instabilidades momentâneas; caso enfrente dificuldades de acesso por um período prolongado, por favor entre em contato com nosso time de _Customer Success_.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"13756696","collectionId":"d15fd15e-25c2-4e27-958a-2a1303f328c9","publishedId":"2s93JwQ2zJ","public":true,"publicUrl":"https://api-docs.yungas.com.br","privateUrl":"https://go.postman.co/documentation/13756696-d15fd15e-25c2-4e27-958a-2a1303f328c9","customColor":{"top-bar":"242f45","right-sidebar":"333333","highlight":"222e44"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":"Yungas Public API Documentation"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"D48182"}},{"name":"light","logo":null,"colors":{"top-bar":"242f45","right-sidebar":"333333","highlight":"222e44"}}]}},"version":"8.10.1","publishDate":"2024-12-10T19:23:16.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Yungas Public API Documentation","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"DOCUMENTATION","id":"f795fa8d-17e1-438d-a98a-101a729c493a","owner":"20193871","values":[{"key":"hostname","value":"https://app.yungas.com.br","enabled":true,"type":"default"},{"key":"client_id","value":"your-client-id","enabled":true,"type":"default"},{"key":"client_secret","value":"your-client-secret","enabled":true,"type":"default"},{"key":"target_host","value":"https://your.webook.handler","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/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://yungas.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":"DOCUMENTATION","value":"20193871-f795fa8d-17e1-438d-a98a-101a729c493a"}],"canonicalUrl":"https://api-docs.yungas.com.br/view/metadata/2s93JwQ2zJ"}