{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"9899db54-0620-45d5-a6da-5b60a9946041","name":"API MXMED CONNECT","description":"\n\n# 📄 Bem vindo ao mxMed Connect\n\nSincronize a agenda da sua clínica com o mxMed através do mxMed Connect.\n\n## 🔖 Por que sincronizar minhas agendas ao mxMed?\n\n- Praticidade para o seu dia a dia. Você pode gerenciar suas agendas diretamente dentro de seu software de gestão interno, sem necessidade de liberar e bloquear horários para evitar agendamentos duplos.\n- Quando um horario seu é ocupado ou liberado em qualquer uma de nossas palataformas de agendamento, nossa API notifica seu sistema de gestão sobre o agendamento, o que irá refletir dieretamente na sua visualização interna. Ou seja, se hover um agendamento, cancelamento ou mudança de agendamento, esta ação sera refeltida no seu sistema interno, sem necessidade de acessar o mxMed para conferência.\n- O mesmo ocorre no sentido inverso, ou seja, se um horário for ocupado ou liberado no seu sistema interno de gestão da sua clínica, ele tambem será ocupado, liberado ou ate mesmo removido do mxMed, evitando desta forma agendamentos duplos para uma mesma data/hora.\n \n\n---\n\n## **O que exatamente é o mxMed Connect?**\n\nO mxMed Connect consiste basicamente em uma API que fornece rotas de acesso para que você possa manter as agendas de seu sistema interno de gestão da sua clínica em comunicação com o mxMed. Otimizando assim o controle de agendas para evitar duplicidades no uso dos horários de seus médicos.\n\nEsta documentação foi criada para que seus desenvolvedores possam se familiarizar e implementar este recurso dentro do sistema de sua clínica.\n\n## **O que você precisa para utilizar o mxMed Connect**\n\n- Ser um utilizador do mxMed Pro\n- Possuir um sistema de clinica que permita integrações com APIs externas\n- Possuir um chave de acesso válida para enviar requests aos endpoints da API. Você deve solicitar esta chave diretamente ao suporte MAXCORE.\n- A API responde somente a comunicações seguras via HTTPS.\n- A API retorna respostas dos requests em formato JSON. O que significa que seu software deve ser capaz de trabalhar com este formato de dados. JSON é atualmente um formato de dados padrão em comunicações entre APIs.\n \n- Sucessos e erros são sempre retornados no STATUS CODE das requisições, conforme tabela descrita neste documento.\n \n\n## Autenticação\n\nA API mxMed Connect usa duas autenticações para validar o acesso, sendo elas:\n\n- Autenticação geral da API do tipo Authentication Basic\n- Autenticação via token, exclusiva da sua clínica\n \n\nAmbas as autenticações são enviadas no header das requisições confome tabela abaixo:\n\n| Header | Descrição |\n| --- | --- |\n| Authorization | Chave global de autenticação de uso na API |\n| customer-key | Chave particular da clínica utilizadora da API |\n\n### Possíveis status codes de retorno\n\n| Https Request Status Code | Descrição |\n| --- | --- |\n| 200 | Sucesso |\n| 500 | Erro interno de servidor |\n| 401 | Falha de autenticação (Verificar se esta enviando as chaves corretamente no header da requisição, conforme tabela anterior) |\n| 400 | Falha de validação do request (verificar o objeto de retorno.
O campo \"message\" irá informar o motivo da recusa) |\n\n### **Precisa de mais ajuda?**\n\nSe possuir questões que não puderam ser responidas através desta documentação, entre em contato conosco através de nosso site em [Maxcore Informática](https://www.maxcore.com.br)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"7978608","team":4556081,"collectionId":"9899db54-0620-45d5-a6da-5b60a9946041","publishedId":"2sA2xfXD2U","public":true,"publicUrl":"https://documenter-api.postman.tech/view/7978608/2sA2xfXD2U","privateUrl":"https://go.postman.co/documentation/7978608-9899db54-0620-45d5-a6da-5b60a9946041","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/b7e063b3-7ba4-4a72-b50f-4853a3badded/bXhNZWRDb25uZWN0TG9nby5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/b7e063b3-7ba4-4a72-b50f-4853a3badded/bXhNZWRDb25uZWN0TG9nby5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-03-06T19:35:10.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/b7e063b3-7ba4-4a72-b50f-4853a3badded/bXhNZWRDb25uZWN0TG9nby5wbmc=","logoDark":"https://content.pstmn.io/b7e063b3-7ba4-4a72-b50f-4853a3badded/bXhNZWRDb25uZWN0TG9nby5wbmc="}},"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/c9d9e161f02c277dc060bde3992852e954ca2adda832d5de07a9658bdf36dd39","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/2sA2xfXD2U"}