{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"8658050b-b380-4f85-9485-a79596ac5d0a","name":"Docway API","description":"O endereço base de comunicação é **service.docway.com.br**, acompanhado sempre do protocolo seguro **https://** como prefixo.\n\nAs APIs são agrupadas por contexto, sufixadas ao endereço base por exemplo: [https://service.docway.com.br/stage-appointment](https://service.docway.com.br/stage-appointment).\n\n| Produção | Sandbox | Stage/Testes | Contexto |\n| --- | --- | --- | --- |\n| appointment | sandbox-appointment | stage-appointment | criação, consulta e gestão de atendimentos |\n| asset | sandbox-asset | stage-asset | consulta de dados de domínio (sintomas, especialidades, CIDs, etc) |\n| asset | sandbox-asset | stage-asset | consulta de dados de domínio (sintomas, especialidades, CIDs, etc) |\n| auth | sandbox-auth | stage-auth | autenticação OAuth de requisições |\n| client | sandbox-client | stage-client | criação, consulta e gestão de clientes (pacientes, médicos, etc) |\n| importdata | sandbox-importdata | stage-importdata | importação de base de elegíveis |\n\nExemplos de stage/teste:\n\n- [https://service.docway.com.br/stage-appointment/{endpoint}](https://service.docway.com.br/stage-appointment/%7Bendpoint%7D)\n \n- [https://service.docway.com.br/stage-asset/{endpoint}](https://service.docway.com.br/stage-asset/%7Bendpoint%7D)\n \n- [https://service.docway.com.br/stage-auth/{endpoint}](https://service.docway.com.br/stage-auth/%7Bendpoint%7D)\n \n- [https://service.docway.com.br/stage-client/{endpoint}](https://service.docway.com.br/stage-client/%7Bendpoint%7D)\n \n- [https://service.docway.com.br/stage-importdata/{endpoint}](https://service.docway.com.br/stage-importdata/%7Bendpoint%7D)\n \n\n# Pré-requisitos\n\n- Credenciais de stage e produção - as credenciais devem ser solicitadas junto à equipe de Tecnologia da Docway.\n \n- Conhecimento em integração de API via REST utilizando JSON e utilizando conceito de webhooks.\n \n- Conhecimento em cURL - interessante para consumir via Postman para testes.\n \n\n# Conceitos\n\n## CMD - Conjunto Mínimo de Dados\n\nA base precisa conter o formato de pontuação como no layout exposto abaixo (caso contrário haverá rompimento dos atendimentos):\n\n- **Nomenclatura do Arquivo:** NomeDoCliente_DatadeEnvio - Exemplo: Docway_15042021.csv\n \n- **Formato do arquivo:** Excel extensão \".csv\", com as colunas separadas por ponto e vírgula\n \n- **Dados do Arquivo:** NOME; CARTEIRINHA; DOCUMENTO; DATA DE NASCIMENTO; TELEFONE; SEXO; E-MAIL; TITULAR; IDENTIFICAÇÃO DO TITULAR.\n \n- **Descrição:**\n \n - **Nome:** nome Completo\n \n - **Carteirinha:** somente números\n \n - **Documento:** CPF somente números\n \n - **Data de Nascimento:** separada por barras DD/MM/AAAA\n \n - **Telefone:** com DDD\n \n - **Sexo:** indicar F ou M\n \n - **Titular ou Dependente:** Indicar T ou D\n \n - **Identificação do titular:** documento de identificação\n \n - **Carteirinha:** somente números, mínimo de 8 dígitos\n \n\n## Beneficíario Elegível vs Pacientes\n\n- **Beneficíario Elegível:** É o beneficiário enviado pela empresa com os dados do CMD que permite o mesmo a ligar na central de orientação telefônico ou acesso via Webview. Uma vez que a base é enviada se um beneficiário o mesmo é excluído por não ter finalidade de elegibilidade.\n \n- **Paciente:** Qualquer pessoa que realizar ao menos uma solicitação de atendimento é convertido de beneficiário elegível para paciente e seus dados são armazenados seguindo regras de salvaguarda de informação médica.\n \n\n## Importação de Bases Elegíveis\n\n- **Leitura de Servidor de Arquivos (FTP/SFTP/AWS S3/Azure Storage):** Ação apenas de **leitura** oriundas de um IP dedicado em servidor de arquivo do cliente realizada uma vez por dia no período da madrugada.\n \n- **Envio de Base via API:** Ação de enviar via request a base .csv podendo ser realizada a qualquer momento e acompanhando as críticas via endpoint também.\n \n\n\n\n## OMT - Orientação Médica por Telefone\n\nO paciente pode entrar em contato via telefone informando seu CPF ou Carteirinha pelo número nacional **3003-6291**\n\n\n\n# Fluxos Comuns\n\n## Solicitação de Atendimento via API (Generalista)\n\nNesse cenário já é realizado o cadastro direto da pessoa como paciente e permitindo a solicitação do atendimento e posterior controle de onde o paciente irá realizar o atendimento, via SDK integrado à plataforma do cliente ou via link do webview. (Lembrando que é possível o envio do link via SMS, Email ou Whatsapp pela própria Docway)\n\n\n\n## Solicitação de Atendimento via API (Especialista)\n\n\n\n## Solicitação de Atendimento via Webview\n\nNesse cenário o link do Webview é enviado para o cliente que pode embarcar em sua plataforma permitindo ao paciente manter um fluxo dentro de uma única jornada. O paciente pode informar os dados e receber o link do atendimento ou aguardar em tela.\n\n\n\n## Consulta de Atendimento Detalhado\n\nEm alguns casos é necessário consultar o atendimento e seus detalhes de forma esporádica ou para acompanhamento do fluxo do paciente. Nesse cenário é necessário apenas o ID do atendimento que irá retornar todos os dados do atendimento via [endpoint](https://documentation.docway.com.br/#57ed01e4-644a-49cf-9fb4-17cfbc9c0a8b)\n\n# Integração com Webview\n\nNeste cenário detalha o acesso via URL para iniciar o fluxo de agendamento, permitindo que a plataforma Docway seja **incorporada (embedada)** em sistemas externos utilizando um componente **Webview** ou **iframe**.\n\nO acesso é realizado através de uma requisição `GET` com parâmetros passados diretamente na URL (_Query Parameters_).\n\n#### URLs de Acesso\n\n| **Ambiente** | **Url Base** |\n| --- | --- |\n| **Stage (Teste)** | `https://stage-patient.docway.com.br/appointment/nomedocliente/create` |\n| **Produção** | `https://patient.docway.com.br/appointment/nomedocliente/create` |\n\n**Nota:** É obrigatório substituir _**nomedocliente**_ pelo identificador exclusivo do seu projeto.\n\n#### Parâmetros de Requisição\n\nOs seguintes parâmetros devem ser fornecidos na URL para identificação e pré-preenchimento dos dados do paciente:\n\n| **Parâmetro** | **Descrição** | Formato de Exemplo | **Status** |\n| --- | --- | --- | --- |\n| carteirinha | Número da carteirinha de identificação do plano/sistema. | 1234567890 | Opcional (veja regra abaixo) |\n| documento | Número do documento de identificação (CPF). | 01111120201 | Opcional (veja regra abaixo) |\n| dataNascimento | Data de nascimento do paciente. | DD/MM/AAAA ou DD-MM-AAAA | Obrigatório |\n| telefone | Telefone de contato do paciente. | 11987654321 | Opcional |\n| email | E-mail do paciente. | [email@dominio.com.br](https://mailto:email@dominio.com.br) | Opcional |\n\n#### Regra de Obrigatoriedade Mínima\n\nPara que a página seja carregada com sucesso, é necessário informar a `dataNascimento` **E** pelo menos um dos campos de identificação (`carteirinha` **OU** `documento`).\n\n#### Exemplo de Requisição Completa (Produção)\n\n```\nhttps://patient.docway.com.br/appointment/nomedocliente/create\n?documento=01111120201&telefone=11987654321&email=email@domini\no.com.br&dataNascimento=01/01/1990\n\n ```\n\n# Webhooks/Callbacks\n\nExiste a funcionalidade de envio de webhook/callback de eventos que acontecem em tempo real para o sistema do cliente.\n\nExemplos de request:\n\n```\n{\n \"eventType\": \"APPOINTMENT_CREATED\",\n \"date\": \"2021-04-01T15:46:15.4330411-03:00\",\n \"resource\": {\n \"appointment\": 9999,\n \"type\": \"OMV\"\n }\n}\n\n ```\n\nOs eventos disponíveis disparados em tempo real são:\n\n- **APPOINTMENT_CREATED** **\\-** Atendimento criado\n \n- **APPOINTMENT_ACCEPTED** **\\-** Atendimento aceito pelo médico\n \n- **APPOINTMENT_CANCELED** **\\-** Atendimento cancelado\n \n- **APPOINTMENT_FINISHED** **\\-** Atendimento Finalizado\n \n- **DOCTOR_CHANGED** **\\-** Alteração de médico\n \n- **DOCTOR_VIDEO_ONLINE** **\\-** Médico entrou na sala\n \n- **APPOINTMENT_DATE_CHANGED** - Alteração de data\n \n- **IMPORTATION_STARTED** **\\-** Importação Iniciada\n \n- **IMPORTATION_COMPLETED** **\\-** Importação Finalizada\n \n- **PATIENT_VIDEO_NOSHOW -** No-show realizado pelo paciente (médico não entrou)\n \n- **DOCTOR_VIDEO_NOSHOW -** No-show realizado pelo médico (paciente não entrou)\n \n- **NURSE_FOLLOWUP -** Atendimento acompanhado por enfermeiro\n \n- **APPOINTMENT_PRESCRIPTION_CREATED** **\\-** Prescriação do atendimento criada\n \n\n# Endpoints","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"2698240","collectionId":"8658050b-b380-4f85-9485-a79596ac5d0a","publishedId":"UVR8pnjQ","public":true,"publicUrl":"https://documentation.docway.com.br","privateUrl":"https://go.postman.co/documentation/2698240-8658050b-b380-4f85-9485-a79596ac5d0a","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"8FD16A"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"8FD16A"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"8FD16A"}}]}},"version":"8.10.0","publishDate":"2023-05-19T11:18:07.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","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":"https://docway.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"}],"canonicalUrl":"https://documentation.docway.com.br/view/metadata/UVR8pnjQ"}