{ "item": [ { "name": "Authentication", "description": { "content": "", "type": "text/plain" }, "item": [ { "name": "Login", "request": { "name": "Login", "description": { "content": "Login via chave de API. Retorna um código de verificação e uma URL de redirecionamento.", "type": "text/plain" }, "url": { "path": [ "v1", "auth", "login" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"consultationInternalId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Resposta bem-sucedida", "originalRequest": { "url": { "path": [ "v1", "auth", "login" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"consultationInternalId\": \"cons_abc123\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Requisição inválida — parâmetros inválidos, falhas de validação ou campos ausentes.", "originalRequest": { "url": { "path": [ "v1", "auth", "login" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"consultationInternalId\": \"cons_abc123\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "auth", "login" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"consultationInternalId\": \"cons_abc123\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "auth", "login" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"consultationInternalId\": \"cons_abc123\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Consultation", "description": { "content": "", "type": "text/plain" }, "item": [ { "name": "Definir contexto da consulta", "request": { "name": "Definir contexto da consulta", "description": { "content": "Define o contexto da consulta para uma sessão do paciente.", "type": "text/plain" }, "url": { "path": [ "v1", "set-consultation-context" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Resposta bem-sucedida", "originalRequest": { "url": { "path": [ "v1", "set-consultation-context" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"consultationInternalId\": \"CONSULT-12345\",\n \"idCountry\": \"COLOMBIA\",\n \"idType\": \"PASSPORT\",\n \"idValue\": \"A12345678\",\n \"institutionalBranchId\": \"b1f2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d\",\n \"internalCode\": \"MRN-000123\",\n \"medicalRecordConfigurationId\": \"mrc_a1b2c3d4e5f6g7h8\",\n \"name\": \"John Doe\",\n \"notes\": \"Patient prefers morning appointments. Allergic to penicillin.\",\n \"pastMedicalHistory\": \"Hypertension diagnosed 2020. Diabetes Type 2 controlled with metformin.\",\n \"scribeSessionModality\": \"IN_PERSON\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Requisição inválida — parâmetros inválidos, falhas de validação ou campos ausentes.", "originalRequest": { "url": { "path": [ "v1", "set-consultation-context" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"consultationInternalId\": \"CONSULT-12345\",\n \"idCountry\": \"COLOMBIA\",\n \"idType\": \"PASSPORT\",\n \"idValue\": \"A12345678\",\n \"institutionalBranchId\": \"b1f2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d\",\n \"internalCode\": \"MRN-000123\",\n \"medicalRecordConfigurationId\": \"mrc_a1b2c3d4e5f6g7h8\",\n \"name\": \"John Doe\",\n \"notes\": \"Patient prefers morning appointments. Allergic to penicillin.\",\n \"pastMedicalHistory\": \"Hypertension diagnosed 2020. Diabetes Type 2 controlled with metformin.\",\n \"scribeSessionModality\": \"IN_PERSON\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "set-consultation-context" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"consultationInternalId\": \"CONSULT-12345\",\n \"idCountry\": \"COLOMBIA\",\n \"idType\": \"PASSPORT\",\n \"idValue\": \"A12345678\",\n \"institutionalBranchId\": \"b1f2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d\",\n \"internalCode\": \"MRN-000123\",\n \"medicalRecordConfigurationId\": \"mrc_a1b2c3d4e5f6g7h8\",\n \"name\": \"John Doe\",\n \"notes\": \"Patient prefers morning appointments. Allergic to penicillin.\",\n \"pastMedicalHistory\": \"Hypertension diagnosed 2020. Diabetes Type 2 controlled with metformin.\",\n \"scribeSessionModality\": \"IN_PERSON\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não encontrado — o recurso solicitado não existe.", "originalRequest": { "url": { "path": [ "v1", "set-consultation-context" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"consultationInternalId\": \"CONSULT-12345\",\n \"idCountry\": \"COLOMBIA\",\n \"idType\": \"PASSPORT\",\n \"idValue\": \"A12345678\",\n \"institutionalBranchId\": \"b1f2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d\",\n \"internalCode\": \"MRN-000123\",\n \"medicalRecordConfigurationId\": \"mrc_a1b2c3d4e5f6g7h8\",\n \"name\": \"John Doe\",\n \"notes\": \"Patient prefers morning appointments. Allergic to penicillin.\",\n \"pastMedicalHistory\": \"Hypertension diagnosed 2020. Diabetes Type 2 controlled with metformin.\",\n \"scribeSessionModality\": \"IN_PERSON\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Conflito — o recurso já existe ou está em estado conflitante.", "originalRequest": { "url": { "path": [ "v1", "set-consultation-context" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"consultationInternalId\": \"CONSULT-12345\",\n \"idCountry\": \"COLOMBIA\",\n \"idType\": \"PASSPORT\",\n \"idValue\": \"A12345678\",\n \"institutionalBranchId\": \"b1f2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d\",\n \"internalCode\": \"MRN-000123\",\n \"medicalRecordConfigurationId\": \"mrc_a1b2c3d4e5f6g7h8\",\n \"name\": \"John Doe\",\n \"notes\": \"Patient prefers morning appointments. Allergic to penicillin.\",\n \"pastMedicalHistory\": \"Hypertension diagnosed 2020. Diabetes Type 2 controlled with metformin.\",\n \"scribeSessionModality\": \"IN_PERSON\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "set-consultation-context" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"consultationInternalId\": \"CONSULT-12345\",\n \"idCountry\": \"COLOMBIA\",\n \"idType\": \"PASSPORT\",\n \"idValue\": \"A12345678\",\n \"institutionalBranchId\": \"b1f2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d\",\n \"internalCode\": \"MRN-000123\",\n \"medicalRecordConfigurationId\": \"mrc_a1b2c3d4e5f6g7h8\",\n \"name\": \"John Doe\",\n \"notes\": \"Patient prefers morning appointments. Allergic to penicillin.\",\n \"pastMedicalHistory\": \"Hypertension diagnosed 2020. Diabetes Type 2 controlled with metformin.\",\n \"scribeSessionModality\": \"IN_PERSON\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Session Scribes", "description": { "content": "", "type": "text/plain" }, "item": [ { "name": "Buscar sessão de Scribe", "request": { "name": "Buscar sessão de Scribe", "description": { "content": "Busca uma sessão de scribe pelo ID.", "type": "text/plain" }, "url": { "path": [ "v1", "scribe-sessions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A sessão a buscar — seu consultationInternalId, ou o id da sessão (ss_...) que a API retorna." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Resposta bem-sucedida", "originalRequest": { "url": { "path": [ "v1", "scribe-sessions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A sessão a buscar — seu consultationInternalId, ou o id da sessão (ss_...) que a API retorna." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Requisição inválida — parâmetros inválidos, falhas de validação ou campos ausentes.", "originalRequest": { "url": { "path": [ "v1", "scribe-sessions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A sessão a buscar — seu consultationInternalId, ou o id da sessão (ss_...) que a API retorna." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "scribe-sessions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A sessão a buscar — seu consultationInternalId, ou o id da sessão (ss_...) que a API retorna." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não encontrado — o recurso solicitado não existe.", "originalRequest": { "url": { "path": [ "v1", "scribe-sessions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A sessão a buscar — seu consultationInternalId, ou o id da sessão (ss_...) que a API retorna." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Precondition Required", "originalRequest": { "url": { "path": [ "v1", "scribe-sessions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A sessão a buscar — seu consultationInternalId, ou o id da sessão (ss_...) que a API retorna." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Precondition Required", "code": 428, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "scribe-sessions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A sessão a buscar — seu consultationInternalId, ou o id da sessão (ss_...) que a API retorna." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Medical Record Documents", "description": { "content": "", "type": "text/plain" }, "item": [ { "name": "Listar documentos de prontuário médico", "request": { "name": "Listar documentos de prontuário médico", "description": { "content": "Lista os documentos de prontuário médico produzidos para uma sessão de scribe.\n\nUm laudo ditado (`purpose` 'report') também traz `reportState`, que indica se o radiologista o assinou. Os demais registros não têm fluxo de trabalho, então seu `reportState` é null. Verifique `reportState.lifecycleStatus` antes de usar um laudo: um `draft` não está completo e o radiologista ainda pode alterá-lo.", "type": "text/plain" }, "url": { "path": [ "v1", "scribe-sessions", ":id", "medical-record-documents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "purpose", "value": "", "description": "Optional filter — return only documents with this purpose. Use 'report' to get only the dictated reports." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A sessão a buscar — seu consultationInternalId, ou o id da sessão (ss_...) que a API retorna." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Resposta bem-sucedida", "originalRequest": { "url": { "path": [ "v1", "scribe-sessions", ":id", "medical-record-documents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "purpose", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A sessão a buscar — seu consultationInternalId, ou o id da sessão (ss_...) que a API retorna." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Requisição inválida — parâmetros inválidos, falhas de validação ou campos ausentes.", "originalRequest": { "url": { "path": [ "v1", "scribe-sessions", ":id", "medical-record-documents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "purpose", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A sessão a buscar — seu consultationInternalId, ou o id da sessão (ss_...) que a API retorna." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "scribe-sessions", ":id", "medical-record-documents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "purpose", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A sessão a buscar — seu consultationInternalId, ou o id da sessão (ss_...) que a API retorna." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Proibido — a chave de API não pode executar esta operação.", "originalRequest": { "url": { "path": [ "v1", "scribe-sessions", ":id", "medical-record-documents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "purpose", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A sessão a buscar — seu consultationInternalId, ou o id da sessão (ss_...) que a API retorna." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não encontrado — o recurso solicitado não existe.", "originalRequest": { "url": { "path": [ "v1", "scribe-sessions", ":id", "medical-record-documents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "purpose", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A sessão a buscar — seu consultationInternalId, ou o id da sessão (ss_...) que a API retorna." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "scribe-sessions", ":id", "medical-record-documents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "purpose", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A sessão a buscar — seu consultationInternalId, ou o id da sessão (ss_...) que a API retorna." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "CDSS", "description": { "content": "", "type": "text/plain" }, "item": [ { "name": "Aceitar um alerta de CDSS", "request": { "name": "Aceitar um alerta de CDSS", "description": { "content": "Registra a decisão do médico de aceitar um alerta de suporte à decisão clínica. A alteração aceita é aplicada ao prontuário de forma assíncrona, então uma resposta de sucesso significa que a decisão foi registrada, não que o prontuário já foi atualizado.", "type": "text/plain" }, "url": { "path": [ "v1", "cdss", "alerts", ":alert_id", "accept" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "alert_id", "description": "(Required) The alert `id` returned by the medical record documents endpoint." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Resposta bem-sucedida", "originalRequest": { "url": { "path": [ "v1", "cdss", "alerts", ":alert_id", "accept" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "alert_id", "description": "(Required) The alert `id` returned by the medical record documents endpoint." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Requisição inválida — parâmetros inválidos, falhas de validação ou campos ausentes.", "originalRequest": { "url": { "path": [ "v1", "cdss", "alerts", ":alert_id", "accept" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "alert_id", "description": "(Required) The alert `id` returned by the medical record documents endpoint." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "cdss", "alerts", ":alert_id", "accept" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "alert_id", "description": "(Required) The alert `id` returned by the medical record documents endpoint." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Proibido — a chave de API não pode executar esta operação.", "originalRequest": { "url": { "path": [ "v1", "cdss", "alerts", ":alert_id", "accept" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "alert_id", "description": "(Required) The alert `id` returned by the medical record documents endpoint." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não encontrado — o recurso solicitado não existe.", "originalRequest": { "url": { "path": [ "v1", "cdss", "alerts", ":alert_id", "accept" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "alert_id", "description": "(Required) The alert `id` returned by the medical record documents endpoint." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Conflito — o recurso já existe ou está em estado conflitante.", "originalRequest": { "url": { "path": [ "v1", "cdss", "alerts", ":alert_id", "accept" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "alert_id", "description": "(Required) The alert `id` returned by the medical record documents endpoint." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "cdss", "alerts", ":alert_id", "accept" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "alert_id", "description": "(Required) The alert `id` returned by the medical record documents endpoint." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Registrar decisões para vários alertas de CDSS", "request": { "name": "Registrar decisões para vários alertas de CDSS", "description": { "content": "Aceita ou rejeita vários alertas de suporte à decisão clínica em uma única chamada. Cada alerta é validado antes de qualquer decisão ser registrada, então um lote que contenha um alerta inutilizável não altera nada. As alterações aceitas são aplicadas ao prontuário de forma assíncrona.", "type": "text/plain" }, "url": { "path": [ "v1", "cdss", "decisions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"decisions\": [\n {\n \"id\": \"\",\n \"decision\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Resposta bem-sucedida", "originalRequest": { "url": { "path": [ "v1", "cdss", "decisions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decisions\": [\n {\n \"decision\": \"accepted\",\n \"id\": \"cfa_bXJkLWFiYy0xMjMfSUJVUFJPRkVO\"\n },\n {\n \"decision\": \"rejected\",\n \"id\": \"cfa_bXJkLWFiYy0xMjMfQVNQSVJJTg\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Requisição inválida — parâmetros inválidos, falhas de validação ou campos ausentes.", "originalRequest": { "url": { "path": [ "v1", "cdss", "decisions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decisions\": [\n {\n \"decision\": \"accepted\",\n \"id\": \"cfa_bXJkLWFiYy0xMjMfSUJVUFJPRkVO\"\n },\n {\n \"decision\": \"rejected\",\n \"id\": \"cfa_bXJkLWFiYy0xMjMfQVNQSVJJTg\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "cdss", "decisions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decisions\": [\n {\n \"decision\": \"accepted\",\n \"id\": \"cfa_bXJkLWFiYy0xMjMfSUJVUFJPRkVO\"\n },\n {\n \"decision\": \"rejected\",\n \"id\": \"cfa_bXJkLWFiYy0xMjMfQVNQSVJJTg\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Proibido — a chave de API não pode executar esta operação.", "originalRequest": { "url": { "path": [ "v1", "cdss", "decisions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decisions\": [\n {\n \"decision\": \"accepted\",\n \"id\": \"cfa_bXJkLWFiYy0xMjMfSUJVUFJPRkVO\"\n },\n {\n \"decision\": \"rejected\",\n \"id\": \"cfa_bXJkLWFiYy0xMjMfQVNQSVJJTg\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não encontrado — o recurso solicitado não existe.", "originalRequest": { "url": { "path": [ "v1", "cdss", "decisions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decisions\": [\n {\n \"decision\": \"accepted\",\n \"id\": \"cfa_bXJkLWFiYy0xMjMfSUJVUFJPRkVO\"\n },\n {\n \"decision\": \"rejected\",\n \"id\": \"cfa_bXJkLWFiYy0xMjMfQVNQSVJJTg\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Conflito — o recurso já existe ou está em estado conflitante.", "originalRequest": { "url": { "path": [ "v1", "cdss", "decisions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decisions\": [\n {\n \"decision\": \"accepted\",\n \"id\": \"cfa_bXJkLWFiYy0xMjMfSUJVUFJPRkVO\"\n },\n {\n \"decision\": \"rejected\",\n \"id\": \"cfa_bXJkLWFiYy0xMjMfQVNQSVJJTg\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "cdss", "decisions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decisions\": [\n {\n \"decision\": \"accepted\",\n \"id\": \"cfa_bXJkLWFiYy0xMjMfSUJVUFJPRkVO\"\n },\n {\n \"decision\": \"rejected\",\n \"id\": \"cfa_bXJkLWFiYy0xMjMfQVNQSVJJTg\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Rejeitar um alerta de CDSS", "request": { "name": "Rejeitar um alerta de CDSS", "description": { "content": "Registra a decisão do médico de rejeitar um alerta de suporte à decisão clínica. O prontuário permanece inalterado.", "type": "text/plain" }, "url": { "path": [ "v1", "cdss", "alerts", ":alert_id", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "alert_id", "description": "(Required) The alert `id` returned by the medical record documents endpoint." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Resposta bem-sucedida", "originalRequest": { "url": { "path": [ "v1", "cdss", "alerts", ":alert_id", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "alert_id", "description": "(Required) The alert `id` returned by the medical record documents endpoint." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Requisição inválida — parâmetros inválidos, falhas de validação ou campos ausentes.", "originalRequest": { "url": { "path": [ "v1", "cdss", "alerts", ":alert_id", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "alert_id", "description": "(Required) The alert `id` returned by the medical record documents endpoint." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "cdss", "alerts", ":alert_id", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "alert_id", "description": "(Required) The alert `id` returned by the medical record documents endpoint." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Proibido — a chave de API não pode executar esta operação.", "originalRequest": { "url": { "path": [ "v1", "cdss", "alerts", ":alert_id", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "alert_id", "description": "(Required) The alert `id` returned by the medical record documents endpoint." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não encontrado — o recurso solicitado não existe.", "originalRequest": { "url": { "path": [ "v1", "cdss", "alerts", ":alert_id", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "alert_id", "description": "(Required) The alert `id` returned by the medical record documents endpoint." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Conflito — o recurso já existe ou está em estado conflitante.", "originalRequest": { "url": { "path": [ "v1", "cdss", "alerts", ":alert_id", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "alert_id", "description": "(Required) The alert `id` returned by the medical record documents endpoint." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "cdss", "alerts", ":alert_id", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "alert_id", "description": "(Required) The alert `id` returned by the medical record documents endpoint." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Scribe Session Configurations", "description": { "content": "", "type": "text/plain" }, "item": [ { "name": "Listar configurações de sessão de scribe", "request": { "name": "Listar configurações de sessão de scribe", "description": { "content": "Lista todas as configurações de sessão de scribe da conta autenticada.", "type": "text/plain" }, "url": { "path": [ "v1", "scribe-session-configurations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Resposta bem-sucedida", "originalRequest": { "url": { "path": [ "v1", "scribe-session-configurations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Requisição inválida — parâmetros inválidos, falhas de validação ou campos ausentes.", "originalRequest": { "url": { "path": [ "v1", "scribe-session-configurations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "scribe-session-configurations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "scribe-session-configurations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Medical Record Configurations", "description": { "content": "", "type": "text/plain" }, "item": [ { "name": "Criar uma Smart Template", "request": { "name": "Criar uma Smart Template", "description": { "content": "Registra uma Smart Template (configuração de prontuário médico). Idempotente por hash de conteúdo: configurações idênticas para a mesma conta retornam o id existente com `created: false`.", "type": "text/plain" }, "url": { "path": [ "v1", "medical-record-configurations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Resposta bem-sucedida", "originalRequest": { "url": { "path": [ "v1", "medical-record-configurations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"configuration\": {\n \"chiefComplaint\": {\n \"instructionSet\": {\n \"telepatiaPromptId\": \"CHIEF_COMPLAINT\"\n },\n \"schema\": {\n \"instructions\": \"Patient's chief complaint.\",\n \"type\": \"string\"\n }\n },\n \"vitals\": {\n \"instructionSet\": {\n \"telepatiaPromptId\": \"VITAL_SIGNS\"\n },\n \"schema\": {\n \"instructions\": \"Vital signs.\",\n \"properties\": {\n \"heartRate\": {\n \"instructions\": \"Heart rate in bpm.\",\n \"type\": \"integer\"\n }\n },\n \"type\": \"object\"\n }\n }\n },\n \"name\": \"Cardiology intake\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Requisição inválida — parâmetros inválidos, falhas de validação ou campos ausentes.", "originalRequest": { "url": { "path": [ "v1", "medical-record-configurations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"configuration\": {\n \"chiefComplaint\": {\n \"instructionSet\": {\n \"telepatiaPromptId\": \"CHIEF_COMPLAINT\"\n },\n \"schema\": {\n \"instructions\": \"Patient's chief complaint.\",\n \"type\": \"string\"\n }\n },\n \"vitals\": {\n \"instructionSet\": {\n \"telepatiaPromptId\": \"VITAL_SIGNS\"\n },\n \"schema\": {\n \"instructions\": \"Vital signs.\",\n \"properties\": {\n \"heartRate\": {\n \"instructions\": \"Heart rate in bpm.\",\n \"type\": \"integer\"\n }\n },\n \"type\": \"object\"\n }\n }\n },\n \"name\": \"Cardiology intake\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "medical-record-configurations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"configuration\": {\n \"chiefComplaint\": {\n \"instructionSet\": {\n \"telepatiaPromptId\": \"CHIEF_COMPLAINT\"\n },\n \"schema\": {\n \"instructions\": \"Patient's chief complaint.\",\n \"type\": \"string\"\n }\n },\n \"vitals\": {\n \"instructionSet\": {\n \"telepatiaPromptId\": \"VITAL_SIGNS\"\n },\n \"schema\": {\n \"instructions\": \"Vital signs.\",\n \"properties\": {\n \"heartRate\": {\n \"instructions\": \"Heart rate in bpm.\",\n \"type\": \"integer\"\n }\n },\n \"type\": \"object\"\n }\n }\n },\n \"name\": \"Cardiology intake\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Conflito — o recurso já existe ou está em estado conflitante.", "originalRequest": { "url": { "path": [ "v1", "medical-record-configurations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"configuration\": {\n \"chiefComplaint\": {\n \"instructionSet\": {\n \"telepatiaPromptId\": \"CHIEF_COMPLAINT\"\n },\n \"schema\": {\n \"instructions\": \"Patient's chief complaint.\",\n \"type\": \"string\"\n }\n },\n \"vitals\": {\n \"instructionSet\": {\n \"telepatiaPromptId\": \"VITAL_SIGNS\"\n },\n \"schema\": {\n \"instructions\": \"Vital signs.\",\n \"properties\": {\n \"heartRate\": {\n \"instructions\": \"Heart rate in bpm.\",\n \"type\": \"integer\"\n }\n },\n \"type\": \"object\"\n }\n }\n },\n \"name\": \"Cardiology intake\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "medical-record-configurations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"configuration\": {\n \"chiefComplaint\": {\n \"instructionSet\": {\n \"telepatiaPromptId\": \"CHIEF_COMPLAINT\"\n },\n \"schema\": {\n \"instructions\": \"Patient's chief complaint.\",\n \"type\": \"string\"\n }\n },\n \"vitals\": {\n \"instructionSet\": {\n \"telepatiaPromptId\": \"VITAL_SIGNS\"\n },\n \"schema\": {\n \"instructions\": \"Vital signs.\",\n \"properties\": {\n \"heartRate\": {\n \"instructions\": \"Heart rate in bpm.\",\n \"type\": \"integer\"\n }\n },\n \"type\": \"object\"\n }\n }\n },\n \"name\": \"Cardiology intake\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Listar Smart Templates", "request": { "name": "Listar Smart Templates", "description": { "content": "Lista as Smart Templates visíveis para o chamador autenticado, paginadas.", "type": "text/plain" }, "url": { "path": [ "v1", "medical-record-configurations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1", "description": "Page number (1-based)." }, { "disabled": false, "key": "limit", "value": "20", "description": "Number of items per page." }, { "disabled": false, "key": "status", "value": "deleted", "description": "Lifecycle-status view. Omit for the default non-deleted list; `deleted` returns only soft-deleted templates (audit view); `all` returns non-deleted + deleted." }, { "disabled": false, "key": "workflow", "value": "defaultOutpatient", "description": "Product discriminator view. Omit to list every value's templates. `defaultOutpatient`, `inpatient`, and `emergencyRoom` filter Scribe templates by clinical care setting; `reportDictation` returns only dictation report templates and `historySummary` only patient-history summarizers." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Resposta bem-sucedida", "originalRequest": { "url": { "path": [ "v1", "medical-record-configurations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "status", "value": "deleted" }, { "key": "workflow", "value": "defaultOutpatient" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Requisição inválida — parâmetros inválidos, falhas de validação ou campos ausentes.", "originalRequest": { "url": { "path": [ "v1", "medical-record-configurations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "status", "value": "deleted" }, { "key": "workflow", "value": "defaultOutpatient" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "medical-record-configurations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "status", "value": "deleted" }, { "key": "workflow", "value": "defaultOutpatient" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Precondition Required", "originalRequest": { "url": { "path": [ "v1", "medical-record-configurations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "status", "value": "deleted" }, { "key": "workflow", "value": "defaultOutpatient" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Precondition Required", "code": 428, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "medical-record-configurations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "status", "value": "deleted" }, { "key": "workflow", "value": "defaultOutpatient" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Buscar uma Smart Template por ID", "request": { "name": "Buscar uma Smart Template por ID", "description": { "content": "Busca uma Smart Template pelo seu identificador público.", "type": "text/plain" }, "url": { "path": [ "v1", "medical-record-configurations", ":configuration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "configuration_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Resposta bem-sucedida", "originalRequest": { "url": { "path": [ "v1", "medical-record-configurations", ":configuration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "configuration_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "medical-record-configurations", ":configuration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "configuration_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não encontrado — o recurso solicitado não existe.", "originalRequest": { "url": { "path": [ "v1", "medical-record-configurations", ":configuration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "configuration_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "medical-record-configurations", ":configuration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "configuration_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Excluir uma Smart Template", "request": { "name": "Excluir uma Smart Template", "description": { "content": "Exclui logicamente uma Smart Template pelo seu identificador público. A template sai da lista padrão; as consultas históricas que a referenciaram não são afetadas. Bloqueada com um 409 enquanto uma sessão de scribe vinculada ainda está em processamento.", "type": "text/plain" }, "url": { "path": [ "v1", "medical-record-configurations", ":configuration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "configuration_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "medical-record-configurations", ":configuration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "configuration_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "_postman_previewlanguage": "text" }, { "name": "Requisição inválida — parâmetros inválidos, falhas de validação ou campos ausentes.", "originalRequest": { "url": { "path": [ "v1", "medical-record-configurations", ":configuration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "configuration_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "medical-record-configurations", ":configuration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "configuration_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Proibido — a chave de API não pode executar esta operação.", "originalRequest": { "url": { "path": [ "v1", "medical-record-configurations", ":configuration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "configuration_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não encontrado — o recurso solicitado não existe.", "originalRequest": { "url": { "path": [ "v1", "medical-record-configurations", ":configuration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "configuration_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Conflito — o recurso já existe ou está em estado conflitante.", "originalRequest": { "url": { "path": [ "v1", "medical-record-configurations", ":configuration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "configuration_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "medical-record-configurations", ":configuration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "configuration_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Appointments", "description": { "content": "", "type": "text/plain" }, "item": [ { "name": "Agendar uma consulta", "request": { "name": "Agendar uma consulta", "description": { "content": "Cria uma consulta agendada (idempotente por consultationInternalId). Devolve o agendamento com seu id público estável (apt_).", "type": "text/plain" }, "url": { "path": [ "v1", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"consultationInternalId\": \"\",\n \"start\": \"\",\n \"end\": \"\",\n \"name\": \"\",\n \"idCountry\": \"\",\n \"idType\": \"\",\n \"idValue\": \"\",\n \"patientId\": \"\",\n \"internalCode\": \"\",\n \"doctorId\": \"\",\n \"minutesDuration\": \"\",\n \"serviceType\": \"\",\n \"appointmentType\": \"\",\n \"reason\": \"\",\n \"description\": \"\",\n \"medicalRecordConfigurationId\": \"\",\n \"scribeSessionModality\": \"\",\n \"notes\": \"\",\n \"pastMedicalHistory\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Resposta bem-sucedida", "originalRequest": { "url": { "path": [ "v1", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"consultationInternalId\": \"CONSULT-12345\",\n \"end\": \"2026-09-01T14:30:00.000Z\",\n \"idCountry\": \"COLOMBIA\",\n \"idType\": \"CC\",\n \"idValue\": \"1024567890\",\n \"medicalRecordConfigurationId\": \"mrc_a1b2c3d4e5f6g7h8\",\n \"name\": \"John Doe\",\n \"reason\": \"Follow-up\",\n \"scribeSessionModality\": \"IN_PERSON\",\n \"serviceType\": \"cardiology\",\n \"start\": \"2026-09-01T14:00:00.000Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Requisição inválida — parâmetros inválidos, falhas de validação ou campos ausentes.", "originalRequest": { "url": { "path": [ "v1", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"consultationInternalId\": \"CONSULT-12345\",\n \"end\": \"2026-09-01T14:30:00.000Z\",\n \"idCountry\": \"COLOMBIA\",\n \"idType\": \"CC\",\n \"idValue\": \"1024567890\",\n \"medicalRecordConfigurationId\": \"mrc_a1b2c3d4e5f6g7h8\",\n \"name\": \"John Doe\",\n \"reason\": \"Follow-up\",\n \"scribeSessionModality\": \"IN_PERSON\",\n \"serviceType\": \"cardiology\",\n \"start\": \"2026-09-01T14:00:00.000Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"consultationInternalId\": \"CONSULT-12345\",\n \"end\": \"2026-09-01T14:30:00.000Z\",\n \"idCountry\": \"COLOMBIA\",\n \"idType\": \"CC\",\n \"idValue\": \"1024567890\",\n \"medicalRecordConfigurationId\": \"mrc_a1b2c3d4e5f6g7h8\",\n \"name\": \"John Doe\",\n \"reason\": \"Follow-up\",\n \"scribeSessionModality\": \"IN_PERSON\",\n \"serviceType\": \"cardiology\",\n \"start\": \"2026-09-01T14:00:00.000Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Proibido — a chave de API não pode executar esta operação.", "originalRequest": { "url": { "path": [ "v1", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"consultationInternalId\": \"CONSULT-12345\",\n \"end\": \"2026-09-01T14:30:00.000Z\",\n \"idCountry\": \"COLOMBIA\",\n \"idType\": \"CC\",\n \"idValue\": \"1024567890\",\n \"medicalRecordConfigurationId\": \"mrc_a1b2c3d4e5f6g7h8\",\n \"name\": \"John Doe\",\n \"reason\": \"Follow-up\",\n \"scribeSessionModality\": \"IN_PERSON\",\n \"serviceType\": \"cardiology\",\n \"start\": \"2026-09-01T14:00:00.000Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não encontrado — o recurso solicitado não existe.", "originalRequest": { "url": { "path": [ "v1", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"consultationInternalId\": \"CONSULT-12345\",\n \"end\": \"2026-09-01T14:30:00.000Z\",\n \"idCountry\": \"COLOMBIA\",\n \"idType\": \"CC\",\n \"idValue\": \"1024567890\",\n \"medicalRecordConfigurationId\": \"mrc_a1b2c3d4e5f6g7h8\",\n \"name\": \"John Doe\",\n \"reason\": \"Follow-up\",\n \"scribeSessionModality\": \"IN_PERSON\",\n \"serviceType\": \"cardiology\",\n \"start\": \"2026-09-01T14:00:00.000Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Conflito — o recurso já existe ou está em estado conflitante.", "originalRequest": { "url": { "path": [ "v1", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"consultationInternalId\": \"CONSULT-12345\",\n \"end\": \"2026-09-01T14:30:00.000Z\",\n \"idCountry\": \"COLOMBIA\",\n \"idType\": \"CC\",\n \"idValue\": \"1024567890\",\n \"medicalRecordConfigurationId\": \"mrc_a1b2c3d4e5f6g7h8\",\n \"name\": \"John Doe\",\n \"reason\": \"Follow-up\",\n \"scribeSessionModality\": \"IN_PERSON\",\n \"serviceType\": \"cardiology\",\n \"start\": \"2026-09-01T14:00:00.000Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"consultationInternalId\": \"CONSULT-12345\",\n \"end\": \"2026-09-01T14:30:00.000Z\",\n \"idCountry\": \"COLOMBIA\",\n \"idType\": \"CC\",\n \"idValue\": \"1024567890\",\n \"medicalRecordConfigurationId\": \"mrc_a1b2c3d4e5f6g7h8\",\n \"name\": \"John Doe\",\n \"reason\": \"Follow-up\",\n \"scribeSessionModality\": \"IN_PERSON\",\n \"serviceType\": \"cardiology\",\n \"start\": \"2026-09-01T14:00:00.000Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Listar agendamentos (agenda)", "request": { "name": "Listar agendamentos (agenda)", "description": { "content": "Lista os agendamentos visíveis para o chamador, ordenados pela hora de início, com filtros de intervalo de início e status, paginados.", "type": "text/plain" }, "url": { "path": [ "v1", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "startFrom", "value": "", "description": "ISO-8601 lower bound on start (inclusive)." }, { "disabled": false, "key": "startTo", "value": "", "description": "ISO-8601 upper bound on start (inclusive)." }, { "disabled": false, "key": "status", "value": "deleted", "description": "Filter by one or more statuses (repeatable)." }, { "disabled": false, "key": "status", "value": "deleted", "description": "Filter by one or more statuses (repeatable)." }, { "disabled": false, "key": "consultationInternalId", "value": "", "description": "Filter to the booking that carries this consultation id." }, { "disabled": false, "key": "page", "value": "1", "description": "Page number (1-based)." }, { "disabled": false, "key": "limit", "value": "20", "description": "Number of items per page." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Resposta bem-sucedida", "originalRequest": { "url": { "path": [ "v1", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startFrom", "value": "" }, { "key": "startTo", "value": "" }, { "key": "status", "value": "deleted" }, { "key": "status", "value": "deleted" }, { "key": "consultationInternalId", "value": "" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Requisição inválida — parâmetros inválidos, falhas de validação ou campos ausentes.", "originalRequest": { "url": { "path": [ "v1", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startFrom", "value": "" }, { "key": "startTo", "value": "" }, { "key": "status", "value": "deleted" }, { "key": "status", "value": "deleted" }, { "key": "consultationInternalId", "value": "" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startFrom", "value": "" }, { "key": "startTo", "value": "" }, { "key": "status", "value": "deleted" }, { "key": "status", "value": "deleted" }, { "key": "consultationInternalId", "value": "" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startFrom", "value": "" }, { "key": "startTo", "value": "" }, { "key": "status", "value": "deleted" }, { "key": "status", "value": "deleted" }, { "key": "consultationInternalId", "value": "" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Consultar um agendamento por ID", "request": { "name": "Consultar um agendamento por ID", "description": { "content": "Consulta um agendamento pelo seu id público (apt_) ou pelo consultationInternalId que você enviou ao criar.", "type": "text/plain" }, "url": { "path": [ "v1", "appointments", ":appointment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Resposta bem-sucedida", "originalRequest": { "url": { "path": [ "v1", "appointments", ":appointment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "appointments", ":appointment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não encontrado — o recurso solicitado não existe.", "originalRequest": { "url": { "path": [ "v1", "appointments", ":appointment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "appointments", ":appointment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Atualizar um agendamento", "request": { "name": "Atualizar um agendamento", "description": { "content": "Cancela uma reserva ou a marca como falta, ou repara um vínculo de sessão perdido. Apenas cancelled e noshow são configuráveis pelo cliente.", "type": "text/plain" }, "url": { "path": [ "v1", "appointments", ":appointment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"\",\n \"scribeSessionId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Resposta bem-sucedida", "originalRequest": { "url": { "path": [ "v1", "appointments", ":appointment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"cancelled\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Requisição inválida — parâmetros inválidos, falhas de validação ou campos ausentes.", "originalRequest": { "url": { "path": [ "v1", "appointments", ":appointment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"cancelled\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "appointments", ":appointment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"cancelled\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Proibido — a chave de API não pode executar esta operação.", "originalRequest": { "url": { "path": [ "v1", "appointments", ":appointment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"cancelled\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não encontrado — o recurso solicitado não existe.", "originalRequest": { "url": { "path": [ "v1", "appointments", ":appointment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"cancelled\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Conflito — o recurso já existe ou está em estado conflitante.", "originalRequest": { "url": { "path": [ "v1", "appointments", ":appointment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"cancelled\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "appointments", ":appointment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"cancelled\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Patients", "description": { "content": "", "type": "text/plain" }, "item": [ { "name": "Criar um paciente", "request": { "name": "Criar um paciente", "description": { "content": "Cria um paciente a partir dos mesmos campos de identidade usados por set-consultation-context. Retorna o paciente com seu id público estável.", "type": "text/plain" }, "url": { "path": [ "v1", "patients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"idCountry\": \"\",\n \"idType\": \"\",\n \"idValue\": \"\",\n \"internalCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Resposta bem-sucedida", "originalRequest": { "url": { "path": [ "v1", "patients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"idCountry\": \"COLOMBIA\",\n \"idType\": \"CC\",\n \"idValue\": \"1024567890\",\n \"internalCode\": \"EMR-12345\",\n \"name\": \"John Doe\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Requisição inválida — parâmetros inválidos, falhas de validação ou campos ausentes.", "originalRequest": { "url": { "path": [ "v1", "patients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"idCountry\": \"COLOMBIA\",\n \"idType\": \"CC\",\n \"idValue\": \"1024567890\",\n \"internalCode\": \"EMR-12345\",\n \"name\": \"John Doe\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "patients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"idCountry\": \"COLOMBIA\",\n \"idType\": \"CC\",\n \"idValue\": \"1024567890\",\n \"internalCode\": \"EMR-12345\",\n \"name\": \"John Doe\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Conflito — o recurso já existe ou está em estado conflitante.", "originalRequest": { "url": { "path": [ "v1", "patients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"idCountry\": \"COLOMBIA\",\n \"idType\": \"CC\",\n \"idValue\": \"1024567890\",\n \"internalCode\": \"EMR-12345\",\n \"name\": \"John Doe\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "patients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"idCountry\": \"COLOMBIA\",\n \"idType\": \"CC\",\n \"idValue\": \"1024567890\",\n \"internalCode\": \"EMR-12345\",\n \"name\": \"John Doe\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Listar pacientes", "request": { "name": "Listar pacientes", "description": { "content": "Lista os pacientes visíveis para o chamador autenticado, paginados.", "type": "text/plain" }, "url": { "path": [ "v1", "patients" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1", "description": "Page number (1-based)." }, { "disabled": false, "key": "limit", "value": "20", "description": "Number of items per page." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Resposta bem-sucedida", "originalRequest": { "url": { "path": [ "v1", "patients" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Requisição inválida — parâmetros inválidos, falhas de validação ou campos ausentes.", "originalRequest": { "url": { "path": [ "v1", "patients" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "patients" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "patients" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Buscar um paciente por ID", "request": { "name": "Buscar um paciente por ID", "description": { "content": "Busca um paciente pelo seu identificador público.", "type": "text/plain" }, "url": { "path": [ "v1", "patients", ":patient_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Resposta bem-sucedida", "originalRequest": { "url": { "path": [ "v1", "patients", ":patient_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "patients", ":patient_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não encontrado — o recurso solicitado não existe.", "originalRequest": { "url": { "path": [ "v1", "patients", ":patient_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "patients", ":patient_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Atualizar um paciente", "request": { "name": "Atualizar um paciente", "description": { "content": "Atualiza o nome ou o internalCode de um paciente. A identidade nacional não é editável aqui.", "type": "text/plain" }, "url": { "path": [ "v1", "patients", ":patient_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"internalCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Resposta bem-sucedida", "originalRequest": { "url": { "path": [ "v1", "patients", ":patient_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"internalCode\": \"EMR-99999\",\n \"name\": \"Jane Doe\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Requisição inválida — parâmetros inválidos, falhas de validação ou campos ausentes.", "originalRequest": { "url": { "path": [ "v1", "patients", ":patient_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"internalCode\": \"EMR-99999\",\n \"name\": \"Jane Doe\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "patients", ":patient_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"internalCode\": \"EMR-99999\",\n \"name\": \"Jane Doe\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Proibido — a chave de API não pode executar esta operação.", "originalRequest": { "url": { "path": [ "v1", "patients", ":patient_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"internalCode\": \"EMR-99999\",\n \"name\": \"Jane Doe\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não encontrado — o recurso solicitado não existe.", "originalRequest": { "url": { "path": [ "v1", "patients", ":patient_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"internalCode\": \"EMR-99999\",\n \"name\": \"Jane Doe\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Conflito — o recurso já existe ou está em estado conflitante.", "originalRequest": { "url": { "path": [ "v1", "patients", ":patient_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"internalCode\": \"EMR-99999\",\n \"name\": \"Jane Doe\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "patients", ":patient_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"internalCode\": \"EMR-99999\",\n \"name\": \"Jane Doe\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Excluir um paciente", "request": { "name": "Excluir um paciente", "description": { "content": "Exclui um paciente pelo seu id público ou internalCode (direito ao esquecimento). Retorna 204.", "type": "text/plain" }, "url": { "path": [ "v1", "patients", ":patient_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "patients", ":patient_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "_postman_previewlanguage": "text" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "patients", ":patient_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Proibido — a chave de API não pode executar esta operação.", "originalRequest": { "url": { "path": [ "v1", "patients", ":patient_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não encontrado — o recurso solicitado não existe.", "originalRequest": { "url": { "path": [ "v1", "patients", ":patient_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "patients", ":patient_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Listar as sessões de scribe de um paciente", "request": { "name": "Listar as sessões de scribe de um paciente", "description": { "content": "Lista as sessões de scribe de um paciente, paginadas. O id do paciente pode ser o id público (sp_...) ou o internalCode que você definiu para a sua instituição.", "type": "text/plain" }, "url": { "path": [ "v1", "patients", ":patient_id", "scribe-sessions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1", "description": "Page number (1-based)." }, { "disabled": false, "key": "limit", "value": "20", "description": "Number of items per page." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Resposta bem-sucedida", "originalRequest": { "url": { "path": [ "v1", "patients", ":patient_id", "scribe-sessions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Requisição inválida — parâmetros inválidos, falhas de validação ou campos ausentes.", "originalRequest": { "url": { "path": [ "v1", "patients", ":patient_id", "scribe-sessions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "patients", ":patient_id", "scribe-sessions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não encontrado — o recurso solicitado não existe.", "originalRequest": { "url": { "path": [ "v1", "patients", ":patient_id", "scribe-sessions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "patients", ":patient_id", "scribe-sessions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Audits", "description": { "content": "", "type": "text/plain" }, "item": [ { "name": "Listar configurações de auditoria", "request": { "name": "Listar configurações de auditoria", "description": { "content": "Lista as rubricas de auditoria atribuídas à instituição, com suas seções e faixas de nota. Requer uma chave institucional.", "type": "text/plain" }, "url": { "path": [ "v1", "audits", "configurations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Resposta bem-sucedida", "originalRequest": { "url": { "path": [ "v1", "audits", "configurations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Requisição inválida — parâmetros inválidos, falhas de validação ou campos ausentes.", "originalRequest": { "url": { "path": [ "v1", "audits", "configurations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "audits", "configurations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Proibido — a chave de API não pode executar esta operação.", "originalRequest": { "url": { "path": [ "v1", "audits", "configurations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "audits", "configurations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Listar auditorias", "request": { "name": "Listar auditorias", "description": { "content": "Lista as auditorias da instituição, paginadas. Requer uma chave institucional.", "type": "text/plain" }, "url": { "path": [ "v1", "audits" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1", "description": "Page number (1-based)." }, { "disabled": false, "key": "limit", "value": "20", "description": "Number of items per page." }, { "disabled": false, "key": "reviewStatus", "value": "pending", "description": "Filter by human-review state: 'pending', 'inReview', or 'reviewed'." }, { "disabled": false, "key": "createdFrom", "value": "", "description": "Only audits created at or after this time (ISO-8601)." }, { "disabled": false, "key": "createdTo", "value": "", "description": "Only audits created at or before this time (ISO-8601)." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Resposta bem-sucedida", "originalRequest": { "url": { "path": [ "v1", "audits" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "reviewStatus", "value": "pending" }, { "key": "createdFrom", "value": "" }, { "key": "createdTo", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Requisição inválida — parâmetros inválidos, falhas de validação ou campos ausentes.", "originalRequest": { "url": { "path": [ "v1", "audits" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "reviewStatus", "value": "pending" }, { "key": "createdFrom", "value": "" }, { "key": "createdTo", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "audits" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "reviewStatus", "value": "pending" }, { "key": "createdFrom", "value": "" }, { "key": "createdTo", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Proibido — a chave de API não pode executar esta operação.", "originalRequest": { "url": { "path": [ "v1", "audits" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "reviewStatus", "value": "pending" }, { "key": "createdFrom", "value": "" }, { "key": "createdTo", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "audits" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "reviewStatus", "value": "pending" }, { "key": "createdFrom", "value": "" }, { "key": "createdTo", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Consultar a auditoria de uma sessão", "request": { "name": "Consultar a auditoria de uma sessão", "description": { "content": "Retorna a auditoria de qualidade de uma sessão de scribe: a pontuação (0..1), a nota e o detalhamento por seções.", "type": "text/plain" }, "url": { "path": [ "v1", "scribe-sessions", ":id", "audit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A sessão a buscar — seu consultationInternalId, ou o id da sessão (ss_...) que a API retorna." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Resposta bem-sucedida", "originalRequest": { "url": { "path": [ "v1", "scribe-sessions", ":id", "audit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A sessão a buscar — seu consultationInternalId, ou o id da sessão (ss_...) que a API retorna." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Requisição inválida — parâmetros inválidos, falhas de validação ou campos ausentes.", "originalRequest": { "url": { "path": [ "v1", "scribe-sessions", ":id", "audit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A sessão a buscar — seu consultationInternalId, ou o id da sessão (ss_...) que a API retorna." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "scribe-sessions", ":id", "audit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A sessão a buscar — seu consultationInternalId, ou o id da sessão (ss_...) que a API retorna." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Proibido — a chave de API não pode executar esta operação.", "originalRequest": { "url": { "path": [ "v1", "scribe-sessions", ":id", "audit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A sessão a buscar — seu consultationInternalId, ou o id da sessão (ss_...) que a API retorna." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não encontrado — o recurso solicitado não existe.", "originalRequest": { "url": { "path": [ "v1", "scribe-sessions", ":id", "audit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A sessão a buscar — seu consultationInternalId, ou o id da sessão (ss_...) que a API retorna." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "scribe-sessions", ":id", "audit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) A sessão a buscar — seu consultationInternalId, ou o id da sessão (ss_...) que a API retorna." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Scribe Sessions", "description": { "content": "", "type": "text/plain" }, "item": [ { "name": "Start a live consultation audio session", "request": { "name": "Start a live consultation audio session", "description": { "content": "Create a consultation and receive a WebSocket URL to stream the audio to. Body is `application/json` with the same metadata as the batch endpoint (`consultation`, `template`, `patient`, `context`); the `audio` block is not accepted. Stream to `live.url` as described on that field, then finish through the webhook + document GET contract shared with the batch endpoint. Retrying with the same consultation id while recording returns the same session with a fresh URL; finished consultations return 409.", "type": "text/plain" }, "url": { "path": [ "v1", "scribe-sessions", "live" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "scribe-sessions", "live" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"consultation\": {\n \"id\": \"CONSULT-12345\",\n \"modality\": \"IN_PERSON\"\n },\n \"template\": {\n \"id\": \"mrc_a1b2c3d4e5f6g7h8\"\n },\n \"patient\": {\n \"id\": \"sp_a1b2c3d4e5f6g7h8\"\n },\n \"context\": {\n \"notes\": \"Patient reports headache since Monday.\",\n \"pastMedicalHistory\": \"Hypertension diagnosed 2020.\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Requisição inválida — parâmetros inválidos, falhas de validação ou campos ausentes.", "originalRequest": { "url": { "path": [ "v1", "scribe-sessions", "live" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"consultation\": {\n \"id\": \"CONSULT-12345\",\n \"modality\": \"IN_PERSON\"\n },\n \"template\": {\n \"id\": \"mrc_a1b2c3d4e5f6g7h8\"\n },\n \"patient\": {\n \"id\": \"sp_a1b2c3d4e5f6g7h8\"\n },\n \"context\": {\n \"notes\": \"Patient reports headache since Monday.\",\n \"pastMedicalHistory\": \"Hypertension diagnosed 2020.\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "scribe-sessions", "live" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"consultation\": {\n \"id\": \"CONSULT-12345\",\n \"modality\": \"IN_PERSON\"\n },\n \"template\": {\n \"id\": \"mrc_a1b2c3d4e5f6g7h8\"\n },\n \"patient\": {\n \"id\": \"sp_a1b2c3d4e5f6g7h8\"\n },\n \"context\": {\n \"notes\": \"Patient reports headache since Monday.\",\n \"pastMedicalHistory\": \"Hypertension diagnosed 2020.\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Proibido — a chave de API não pode executar esta operação.", "originalRequest": { "url": { "path": [ "v1", "scribe-sessions", "live" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"consultation\": {\n \"id\": \"CONSULT-12345\",\n \"modality\": \"IN_PERSON\"\n },\n \"template\": {\n \"id\": \"mrc_a1b2c3d4e5f6g7h8\"\n },\n \"patient\": {\n \"id\": \"sp_a1b2c3d4e5f6g7h8\"\n },\n \"context\": {\n \"notes\": \"Patient reports headache since Monday.\",\n \"pastMedicalHistory\": \"Hypertension diagnosed 2020.\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não encontrado — o recurso solicitado não existe.", "originalRequest": { "url": { "path": [ "v1", "scribe-sessions", "live" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"consultation\": {\n \"id\": \"CONSULT-12345\",\n \"modality\": \"IN_PERSON\"\n },\n \"template\": {\n \"id\": \"mrc_a1b2c3d4e5f6g7h8\"\n },\n \"patient\": {\n \"id\": \"sp_a1b2c3d4e5f6g7h8\"\n },\n \"context\": {\n \"notes\": \"Patient reports headache since Monday.\",\n \"pastMedicalHistory\": \"Hypertension diagnosed 2020.\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Conflito — o recurso já existe ou está em estado conflitante.", "originalRequest": { "url": { "path": [ "v1", "scribe-sessions", "live" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"consultation\": {\n \"id\": \"CONSULT-12345\",\n \"modality\": \"IN_PERSON\"\n },\n \"template\": {\n \"id\": \"mrc_a1b2c3d4e5f6g7h8\"\n },\n \"patient\": {\n \"id\": \"sp_a1b2c3d4e5f6g7h8\"\n },\n \"context\": {\n \"notes\": \"Patient reports headache since Monday.\",\n \"pastMedicalHistory\": \"Hypertension diagnosed 2020.\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Content Too Large", "originalRequest": { "url": { "path": [ "v1", "scribe-sessions", "live" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"consultation\": {\n \"id\": \"CONSULT-12345\",\n \"modality\": \"IN_PERSON\"\n },\n \"template\": {\n \"id\": \"mrc_a1b2c3d4e5f6g7h8\"\n },\n \"patient\": {\n \"id\": \"sp_a1b2c3d4e5f6g7h8\"\n },\n \"context\": {\n \"notes\": \"Patient reports headache since Monday.\",\n \"pastMedicalHistory\": \"Hypertension diagnosed 2020.\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "scribe-sessions", "live" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"consultation\": {\n \"id\": \"CONSULT-12345\",\n \"modality\": \"IN_PERSON\"\n },\n \"template\": {\n \"id\": \"mrc_a1b2c3d4e5f6g7h8\"\n },\n \"patient\": {\n \"id\": \"sp_a1b2c3d4e5f6g7h8\"\n },\n \"context\": {\n \"notes\": \"Patient reports headache since Monday.\",\n \"pastMedicalHistory\": \"Hypertension diagnosed 2020.\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Webhooks", "description": { "content": "", "type": "text/plain" }, "item": [ { "name": "Listar assinaturas de webhook", "request": { "name": "Listar assinaturas de webhook", "description": { "content": "Lista as assinaturas de webhook visíveis para o chamador autenticado.", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Resposta bem-sucedida", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Criar uma assinatura de webhook", "request": { "name": "Criar uma assinatura de webhook", "description": { "content": "Registra um webhook para receber notificações de eventos. A resposta inclui o `signingSecret` —mostrado apenas uma vez— usado para verificar o cabeçalho `X-Scribe-Api-Signature`.", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"name\": \"\",\n \"events\": [\n \"\",\n \"\"\n ],\n \"event\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Resposta bem-sucedida", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"events\": [\n \"scribe_session.created\",\n \"scribe_session.completed\",\n \"scribe_session.error\"\n ],\n \"name\": \"Scribe prod webhook\",\n \"url\": \"https://example.com/webhooks/scribe\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Requisição inválida — parâmetros inválidos, falhas de validação ou campos ausentes.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"events\": [\n \"scribe_session.created\",\n \"scribe_session.completed\",\n \"scribe_session.error\"\n ],\n \"name\": \"Scribe prod webhook\",\n \"url\": \"https://example.com/webhooks/scribe\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"events\": [\n \"scribe_session.created\",\n \"scribe_session.completed\",\n \"scribe_session.error\"\n ],\n \"name\": \"Scribe prod webhook\",\n \"url\": \"https://example.com/webhooks/scribe\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Proibido — a chave de API não pode executar esta operação.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"events\": [\n \"scribe_session.created\",\n \"scribe_session.completed\",\n \"scribe_session.error\"\n ],\n \"name\": \"Scribe prod webhook\",\n \"url\": \"https://example.com/webhooks/scribe\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"events\": [\n \"scribe_session.created\",\n \"scribe_session.completed\",\n \"scribe_session.error\"\n ],\n \"name\": \"Scribe prod webhook\",\n \"url\": \"https://example.com/webhooks/scribe\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Rotacionar o segredo de assinatura de um webhook", "request": { "name": "Rotacionar o segredo de assinatura de um webhook", "description": { "content": "Gera um novo segredo de assinatura para o webhook, incrementando sua versão. O novo `signingSecret` é mostrado apenas uma vez. O segredo anterior deixa de verificar imediatamente.", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", ":webhook_id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "webhook_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Resposta bem-sucedida", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhook_id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "webhook_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhook_id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "webhook_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Proibido — a chave de API não pode executar esta operação.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhook_id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "webhook_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não encontrado — o recurso solicitado não existe.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhook_id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "webhook_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhook_id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "webhook_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Buscar uma assinatura de webhook por ID", "request": { "name": "Buscar uma assinatura de webhook por ID", "description": {}, "url": { "path": [ "v1", "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "webhook_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Resposta bem-sucedida", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "webhook_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "webhook_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Proibido — a chave de API não pode executar esta operação.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "webhook_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não encontrado — o recurso solicitado não existe.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "webhook_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "webhook_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Atualizar uma assinatura de webhook", "request": { "name": "Atualizar uma assinatura de webhook", "description": { "content": "Altera a url, o tipo de evento ou o indicador de atividade de uma assinatura de webhook.", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "webhook_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"name\": \"\",\n \"events\": [\n \"\",\n \"\"\n ],\n \"event\": \"\",\n \"isActive\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Resposta bem-sucedida", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "webhook_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"events\": [\n \"scribe_session.completed\",\n \"scribe_session.error\"\n ],\n \"isActive\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Requisição inválida — parâmetros inválidos, falhas de validação ou campos ausentes.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "webhook_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"events\": [\n \"scribe_session.completed\",\n \"scribe_session.error\"\n ],\n \"isActive\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "webhook_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"events\": [\n \"scribe_session.completed\",\n \"scribe_session.error\"\n ],\n \"isActive\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Proibido — a chave de API não pode executar esta operação.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "webhook_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"events\": [\n \"scribe_session.completed\",\n \"scribe_session.error\"\n ],\n \"isActive\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não encontrado — o recurso solicitado não existe.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "webhook_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"events\": [\n \"scribe_session.completed\",\n \"scribe_session.error\"\n ],\n \"isActive\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "webhook_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"events\": [\n \"scribe_session.completed\",\n \"scribe_session.error\"\n ],\n \"isActive\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Institutional", "description": { "content": "", "type": "text/plain" }, "item": [ { "name": "Criar uma conta de médico", "request": { "name": "Criar uma conta de médico", "description": { "content": "Cria uma nova conta de médico para a instituição autenticada. Se `internalCode` for fornecido, ele atua como chave de idempotência: enviar o mesmo valor duas vezes retorna um 409.", "type": "text/plain" }, "url": { "path": [ "v1", "institutional", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"doctorSpecialties\": [\n \"\"\n ],\n \"country\": \"\",\n \"language\": \"\",\n \"timeZone\": \"\",\n \"nameFull\": \"\",\n \"institutionalBranchName\": \"\",\n \"internalCode\": \"\",\n \"apiKeyConfig\": {\n \"validForDays\": 365\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apiKeyConfig\": {\n \"validForDays\": 365\n },\n \"country\": \"CO\",\n \"doctorSpecialties\": [\n \"cardiology\"\n ],\n \"email\": \"dr.juan@clinica.com\",\n \"institutionalBranchName\": \"Sede Norte\",\n \"internalCode\": \"DOC-001\",\n \"language\": \"es\",\n \"nameFull\": \"Dr. Juan Pérez\",\n \"timeZone\": \"America/Bogota\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Requisição inválida — parâmetros inválidos, falhas de validação ou campos ausentes.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apiKeyConfig\": {\n \"validForDays\": 365\n },\n \"country\": \"CO\",\n \"doctorSpecialties\": [\n \"cardiology\"\n ],\n \"email\": \"dr.juan@clinica.com\",\n \"institutionalBranchName\": \"Sede Norte\",\n \"internalCode\": \"DOC-001\",\n \"language\": \"es\",\n \"nameFull\": \"Dr. Juan Pérez\",\n \"timeZone\": \"America/Bogota\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apiKeyConfig\": {\n \"validForDays\": 365\n },\n \"country\": \"CO\",\n \"doctorSpecialties\": [\n \"cardiology\"\n ],\n \"email\": \"dr.juan@clinica.com\",\n \"institutionalBranchName\": \"Sede Norte\",\n \"internalCode\": \"DOC-001\",\n \"language\": \"es\",\n \"nameFull\": \"Dr. Juan Pérez\",\n \"timeZone\": \"America/Bogota\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Proibido — a chave de API não pode executar esta operação.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apiKeyConfig\": {\n \"validForDays\": 365\n },\n \"country\": \"CO\",\n \"doctorSpecialties\": [\n \"cardiology\"\n ],\n \"email\": \"dr.juan@clinica.com\",\n \"institutionalBranchName\": \"Sede Norte\",\n \"internalCode\": \"DOC-001\",\n \"language\": \"es\",\n \"nameFull\": \"Dr. Juan Pérez\",\n \"timeZone\": \"America/Bogota\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Conflito — o recurso já existe ou está em estado conflitante.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apiKeyConfig\": {\n \"validForDays\": 365\n },\n \"country\": \"CO\",\n \"doctorSpecialties\": [\n \"cardiology\"\n ],\n \"email\": \"dr.juan@clinica.com\",\n \"institutionalBranchName\": \"Sede Norte\",\n \"internalCode\": \"DOC-001\",\n \"language\": \"es\",\n \"nameFull\": \"Dr. Juan Pérez\",\n \"timeZone\": \"America/Bogota\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apiKeyConfig\": {\n \"validForDays\": 365\n },\n \"country\": \"CO\",\n \"doctorSpecialties\": [\n \"cardiology\"\n ],\n \"email\": \"dr.juan@clinica.com\",\n \"institutionalBranchName\": \"Sede Norte\",\n \"internalCode\": \"DOC-001\",\n \"language\": \"es\",\n \"nameFull\": \"Dr. Juan Pérez\",\n \"timeZone\": \"America/Bogota\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Criar uma conta de médico", "request": { "name": "Criar uma conta de médico", "description": { "content": "Cria uma nova conta de médico para a instituição autenticada. Se `internalCode` for fornecido, ele atua como chave de idempotência: enviar o mesmo valor duas vezes retorna um 409.", "type": "text/plain" }, "url": { "path": [ "v1", "institutional", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"doctorSpecialties\": [\n \"\"\n ],\n \"country\": \"\",\n \"language\": \"\",\n \"timeZone\": \"\",\n \"nameFull\": \"\",\n \"institutionalBranchName\": \"\",\n \"internalCode\": \"\",\n \"apiKeyConfig\": {\n \"validForDays\": 365\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apiKeyConfig\": {\n \"validForDays\": 365\n },\n \"country\": \"CO\",\n \"doctorSpecialties\": [\n \"cardiology\"\n ],\n \"email\": \"dr.juan@clinica.com\",\n \"institutionalBranchName\": \"Sede Norte\",\n \"internalCode\": \"DOC-001\",\n \"language\": \"es\",\n \"nameFull\": \"Dr. Juan Pérez\",\n \"timeZone\": \"America/Bogota\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Requisição inválida — parâmetros inválidos, falhas de validação ou campos ausentes.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apiKeyConfig\": {\n \"validForDays\": 365\n },\n \"country\": \"CO\",\n \"doctorSpecialties\": [\n \"cardiology\"\n ],\n \"email\": \"dr.juan@clinica.com\",\n \"institutionalBranchName\": \"Sede Norte\",\n \"internalCode\": \"DOC-001\",\n \"language\": \"es\",\n \"nameFull\": \"Dr. Juan Pérez\",\n \"timeZone\": \"America/Bogota\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apiKeyConfig\": {\n \"validForDays\": 365\n },\n \"country\": \"CO\",\n \"doctorSpecialties\": [\n \"cardiology\"\n ],\n \"email\": \"dr.juan@clinica.com\",\n \"institutionalBranchName\": \"Sede Norte\",\n \"internalCode\": \"DOC-001\",\n \"language\": \"es\",\n \"nameFull\": \"Dr. Juan Pérez\",\n \"timeZone\": \"America/Bogota\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Proibido — a chave de API não pode executar esta operação.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apiKeyConfig\": {\n \"validForDays\": 365\n },\n \"country\": \"CO\",\n \"doctorSpecialties\": [\n \"cardiology\"\n ],\n \"email\": \"dr.juan@clinica.com\",\n \"institutionalBranchName\": \"Sede Norte\",\n \"internalCode\": \"DOC-001\",\n \"language\": \"es\",\n \"nameFull\": \"Dr. Juan Pérez\",\n \"timeZone\": \"America/Bogota\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Conflito — o recurso já existe ou está em estado conflitante.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apiKeyConfig\": {\n \"validForDays\": 365\n },\n \"country\": \"CO\",\n \"doctorSpecialties\": [\n \"cardiology\"\n ],\n \"email\": \"dr.juan@clinica.com\",\n \"institutionalBranchName\": \"Sede Norte\",\n \"internalCode\": \"DOC-001\",\n \"language\": \"es\",\n \"nameFull\": \"Dr. Juan Pérez\",\n \"timeZone\": \"America/Bogota\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apiKeyConfig\": {\n \"validForDays\": 365\n },\n \"country\": \"CO\",\n \"doctorSpecialties\": [\n \"cardiology\"\n ],\n \"email\": \"dr.juan@clinica.com\",\n \"institutionalBranchName\": \"Sede Norte\",\n \"internalCode\": \"DOC-001\",\n \"language\": \"es\",\n \"nameFull\": \"Dr. Juan Pérez\",\n \"timeZone\": \"America/Bogota\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Listar as contas da instituição", "request": { "name": "Listar as contas da instituição", "description": { "content": "Retorna id, nameFull, email e disabledAt de cada conta da instituição autenticada. Paginado.", "type": "text/plain" }, "url": { "path": [ "v1", "institutional", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Resposta bem-sucedida", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Listar as contas da instituição", "request": { "name": "Listar as contas da instituição", "description": { "content": "Retorna id, nameFull, email e disabledAt de cada conta da instituição autenticada. Paginado.", "type": "text/plain" }, "url": { "path": [ "v1", "institutional", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Resposta bem-sucedida", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Criar contas de médico em lote", "request": { "name": "Criar contas de médico em lote", "description": { "content": "Cria várias contas de médico para a instituição autenticada em uma única chamada (1–10 contas). Cada item recebe os mesmos campos que `POST /accounts`. Toda a requisição é rejeitada com um 400 antes de criar qualquer conta quando repete um `email` ou um `internalCode`. Como cada conta é confirmada de forma independente, o endpoint não faz rollback: retorna um 200 com um arranjo `results` por item —uma entrada por conta, na ordem recebida, marcada como `created` ou `error`— mais `createdCount` e `failedCount`.", "type": "text/plain" }, "url": { "path": [ "v1", "institutional", "accounts", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"accounts\": [\n {\n \"email\": \"\",\n \"doctorSpecialties\": [\n \"\"\n ],\n \"country\": \"\",\n \"language\": \"\",\n \"timeZone\": \"\",\n \"nameFull\": \"\",\n \"institutionalBranchName\": \"\",\n \"internalCode\": \"\",\n \"apiKeyConfig\": {\n \"validForDays\": 365\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Resposta bem-sucedida", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accounts\": [\n {\n \"doctorSpecialties\": [\n \"cardiology\"\n ],\n \"email\": \"dr.juan@clinica.com\",\n \"internalCode\": \"DOC-001\",\n \"nameFull\": \"Dr. Juan Pérez\"\n },\n {\n \"doctorSpecialties\": [\n \"pediatrics\"\n ],\n \"email\": \"dra.ana@clinica.com\",\n \"internalCode\": \"DOC-002\",\n \"nameFull\": \"Dra. Ana Gómez\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Requisição inválida — parâmetros inválidos, falhas de validação ou campos ausentes.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accounts\": [\n {\n \"doctorSpecialties\": [\n \"cardiology\"\n ],\n \"email\": \"dr.juan@clinica.com\",\n \"internalCode\": \"DOC-001\",\n \"nameFull\": \"Dr. Juan Pérez\"\n },\n {\n \"doctorSpecialties\": [\n \"pediatrics\"\n ],\n \"email\": \"dra.ana@clinica.com\",\n \"internalCode\": \"DOC-002\",\n \"nameFull\": \"Dra. Ana Gómez\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accounts\": [\n {\n \"doctorSpecialties\": [\n \"cardiology\"\n ],\n \"email\": \"dr.juan@clinica.com\",\n \"internalCode\": \"DOC-001\",\n \"nameFull\": \"Dr. Juan Pérez\"\n },\n {\n \"doctorSpecialties\": [\n \"pediatrics\"\n ],\n \"email\": \"dra.ana@clinica.com\",\n \"internalCode\": \"DOC-002\",\n \"nameFull\": \"Dra. Ana Gómez\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Proibido — a chave de API não pode executar esta operação.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accounts\": [\n {\n \"doctorSpecialties\": [\n \"cardiology\"\n ],\n \"email\": \"dr.juan@clinica.com\",\n \"internalCode\": \"DOC-001\",\n \"nameFull\": \"Dr. Juan Pérez\"\n },\n {\n \"doctorSpecialties\": [\n \"pediatrics\"\n ],\n \"email\": \"dra.ana@clinica.com\",\n \"internalCode\": \"DOC-002\",\n \"nameFull\": \"Dra. Ana Gómez\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accounts\": [\n {\n \"doctorSpecialties\": [\n \"cardiology\"\n ],\n \"email\": \"dr.juan@clinica.com\",\n \"internalCode\": \"DOC-001\",\n \"nameFull\": \"Dr. Juan Pérez\"\n },\n {\n \"doctorSpecialties\": [\n \"pediatrics\"\n ],\n \"email\": \"dra.ana@clinica.com\",\n \"internalCode\": \"DOC-002\",\n \"nameFull\": \"Dra. Ana Gómez\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Criar contas de médico em lote", "request": { "name": "Criar contas de médico em lote", "description": { "content": "Cria várias contas de médico para a instituição autenticada em uma única chamada (1–10 contas). Cada item recebe os mesmos campos que `POST /accounts`. Toda a requisição é rejeitada com um 400 antes de criar qualquer conta quando repete um `email` ou um `internalCode`. Como cada conta é confirmada de forma independente, o endpoint não faz rollback: retorna um 200 com um arranjo `results` por item —uma entrada por conta, na ordem recebida, marcada como `created` ou `error`— mais `createdCount` e `failedCount`.", "type": "text/plain" }, "url": { "path": [ "v1", "institutional", "accounts", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"accounts\": [\n {\n \"email\": \"\",\n \"doctorSpecialties\": [\n \"\"\n ],\n \"country\": \"\",\n \"language\": \"\",\n \"timeZone\": \"\",\n \"nameFull\": \"\",\n \"institutionalBranchName\": \"\",\n \"internalCode\": \"\",\n \"apiKeyConfig\": {\n \"validForDays\": 365\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Resposta bem-sucedida", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accounts\": [\n {\n \"doctorSpecialties\": [\n \"cardiology\"\n ],\n \"email\": \"dr.juan@clinica.com\",\n \"internalCode\": \"DOC-001\",\n \"nameFull\": \"Dr. Juan Pérez\"\n },\n {\n \"doctorSpecialties\": [\n \"pediatrics\"\n ],\n \"email\": \"dra.ana@clinica.com\",\n \"internalCode\": \"DOC-002\",\n \"nameFull\": \"Dra. Ana Gómez\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Requisição inválida — parâmetros inválidos, falhas de validação ou campos ausentes.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accounts\": [\n {\n \"doctorSpecialties\": [\n \"cardiology\"\n ],\n \"email\": \"dr.juan@clinica.com\",\n \"internalCode\": \"DOC-001\",\n \"nameFull\": \"Dr. Juan Pérez\"\n },\n {\n \"doctorSpecialties\": [\n \"pediatrics\"\n ],\n \"email\": \"dra.ana@clinica.com\",\n \"internalCode\": \"DOC-002\",\n \"nameFull\": \"Dra. Ana Gómez\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accounts\": [\n {\n \"doctorSpecialties\": [\n \"cardiology\"\n ],\n \"email\": \"dr.juan@clinica.com\",\n \"internalCode\": \"DOC-001\",\n \"nameFull\": \"Dr. Juan Pérez\"\n },\n {\n \"doctorSpecialties\": [\n \"pediatrics\"\n ],\n \"email\": \"dra.ana@clinica.com\",\n \"internalCode\": \"DOC-002\",\n \"nameFull\": \"Dra. Ana Gómez\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Proibido — a chave de API não pode executar esta operação.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accounts\": [\n {\n \"doctorSpecialties\": [\n \"cardiology\"\n ],\n \"email\": \"dr.juan@clinica.com\",\n \"internalCode\": \"DOC-001\",\n \"nameFull\": \"Dr. Juan Pérez\"\n },\n {\n \"doctorSpecialties\": [\n \"pediatrics\"\n ],\n \"email\": \"dra.ana@clinica.com\",\n \"internalCode\": \"DOC-002\",\n \"nameFull\": \"Dra. Ana Gómez\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accounts\": [\n {\n \"doctorSpecialties\": [\n \"cardiology\"\n ],\n \"email\": \"dr.juan@clinica.com\",\n \"internalCode\": \"DOC-001\",\n \"nameFull\": \"Dr. Juan Pérez\"\n },\n {\n \"doctorSpecialties\": [\n \"pediatrics\"\n ],\n \"email\": \"dra.ana@clinica.com\",\n \"internalCode\": \"DOC-002\",\n \"nameFull\": \"Dra. Ana Gómez\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Criar uma filial", "request": { "name": "Criar uma filial", "description": { "content": "Cria uma nova filial para a instituição autenticada. Apenas `name` é obrigatório; os campos omitidos usam os valores padrão do servidor. O nome da filial deve ser único dentro da instituição: um duplicado retorna um 409. Depois de criada, a filial pode ser referenciada como `institutionalBranchName` ao criar contas.", "type": "text/plain" }, "url": { "path": [ "v1", "institutional", "branches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"type\": \"\",\n \"visible\": \"\",\n \"main\": \"\",\n \"order\": \"\",\n \"description\": \"\",\n \"address\": \"\",\n \"IPS\": [\n \"\",\n \"\"\n ],\n \"coordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"expectedConsultations\": \"\",\n \"branchManagerAccountIds\": [\n \"\",\n \"\"\n ],\n \"cdssConfigurationId\": \"\",\n \"auditConfigurationId\": \"\",\n \"sessionStartLabel\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "institutional", "branches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"Av. 7 #12-34\",\n \"main\": false,\n \"name\": \"Sede Norte\",\n \"type\": \"single\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Requisição inválida — parâmetros inválidos, falhas de validação ou campos ausentes.", "originalRequest": { "url": { "path": [ "v1", "institutional", "branches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"Av. 7 #12-34\",\n \"main\": false,\n \"name\": \"Sede Norte\",\n \"type\": \"single\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "institutional", "branches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"Av. 7 #12-34\",\n \"main\": false,\n \"name\": \"Sede Norte\",\n \"type\": \"single\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Proibido — a chave de API não pode executar esta operação.", "originalRequest": { "url": { "path": [ "v1", "institutional", "branches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"Av. 7 #12-34\",\n \"main\": false,\n \"name\": \"Sede Norte\",\n \"type\": \"single\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Conflito — o recurso já existe ou está em estado conflitante.", "originalRequest": { "url": { "path": [ "v1", "institutional", "branches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"Av. 7 #12-34\",\n \"main\": false,\n \"name\": \"Sede Norte\",\n \"type\": \"single\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "institutional", "branches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"Av. 7 #12-34\",\n \"main\": false,\n \"name\": \"Sede Norte\",\n \"type\": \"single\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Criar uma filial", "request": { "name": "Criar uma filial", "description": { "content": "Cria uma nova filial para a instituição autenticada. Apenas `name` é obrigatório; os campos omitidos usam os valores padrão do servidor. O nome da filial deve ser único dentro da instituição: um duplicado retorna um 409. Depois de criada, a filial pode ser referenciada como `institutionalBranchName` ao criar contas.", "type": "text/plain" }, "url": { "path": [ "v1", "institutional", "branches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"type\": \"\",\n \"visible\": \"\",\n \"main\": \"\",\n \"order\": \"\",\n \"description\": \"\",\n \"address\": \"\",\n \"IPS\": [\n \"\",\n \"\"\n ],\n \"coordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"expectedConsultations\": \"\",\n \"branchManagerAccountIds\": [\n \"\",\n \"\"\n ],\n \"cdssConfigurationId\": \"\",\n \"auditConfigurationId\": \"\",\n \"sessionStartLabel\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "institutional", "branches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"Av. 7 #12-34\",\n \"main\": false,\n \"name\": \"Sede Norte\",\n \"type\": \"single\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Requisição inválida — parâmetros inválidos, falhas de validação ou campos ausentes.", "originalRequest": { "url": { "path": [ "v1", "institutional", "branches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"Av. 7 #12-34\",\n \"main\": false,\n \"name\": \"Sede Norte\",\n \"type\": \"single\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "institutional", "branches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"Av. 7 #12-34\",\n \"main\": false,\n \"name\": \"Sede Norte\",\n \"type\": \"single\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Proibido — a chave de API não pode executar esta operação.", "originalRequest": { "url": { "path": [ "v1", "institutional", "branches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"Av. 7 #12-34\",\n \"main\": false,\n \"name\": \"Sede Norte\",\n \"type\": \"single\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Conflito — o recurso já existe ou está em estado conflitante.", "originalRequest": { "url": { "path": [ "v1", "institutional", "branches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"Av. 7 #12-34\",\n \"main\": false,\n \"name\": \"Sede Norte\",\n \"type\": \"single\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "institutional", "branches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"Av. 7 #12-34\",\n \"main\": false,\n \"name\": \"Sede Norte\",\n \"type\": \"single\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Buscar uma conta de médico", "request": { "name": "Buscar uma conta de médico", "description": { "content": "Obtém uma conta de médico pelo seu `publicId` (formato: `acc_*`) ou pelo seu `internalCode` (o identificador interno da sua instituição).", "type": "text/plain" }, "url": { "path": [ "v1", "institutional", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Resposta bem-sucedida", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não encontrado — o recurso solicitado não existe.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Buscar uma conta de médico", "request": { "name": "Buscar uma conta de médico", "description": { "content": "Obtém uma conta de médico pelo seu `publicId` (formato: `acc_*`) ou pelo seu `internalCode` (o identificador interno da sua instituição).", "type": "text/plain" }, "url": { "path": [ "v1", "institutional", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "name": "Resposta bem-sucedida", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não encontrado — o recurso solicitado não existe.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Regenerar a chave de API de uma conta de médico", "request": { "name": "Regenerar a chave de API de uma conta de médico", "description": { "content": "Rotaciona a chave de API de uma conta de médico, identificada pelo seu `publicId` (`acc_*`) ou `internalCode`. A chave anterior é revogada com uma breve janela de carência; a nova chave em texto puro é retornada **uma única vez** — guarde-a com segurança. Limitado a uma regeneração por conta a cada 2 minutos (`429 rate_limit_exceeded`).", "type": "text/plain" }, "url": { "path": [ "v1", "institutional", "accounts", ":account_id", "api-keys", "regenerate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"validForDays\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Resposta bem-sucedida", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts", ":account_id", "api-keys", "regenerate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"validForDays\": 365\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts", ":account_id", "api-keys", "regenerate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"validForDays\": 365\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Proibido — a chave de API não pode executar esta operação.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts", ":account_id", "api-keys", "regenerate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"validForDays\": 365\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não encontrado — o recurso solicitado não existe.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts", ":account_id", "api-keys", "regenerate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"validForDays\": 365\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Conflito — o recurso já existe ou está em estado conflitante.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts", ":account_id", "api-keys", "regenerate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"validForDays\": 365\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts", ":account_id", "api-keys", "regenerate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"validForDays\": 365\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts", ":account_id", "api-keys", "regenerate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"validForDays\": 365\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Regenerar a chave de API de uma conta de médico", "request": { "name": "Regenerar a chave de API de uma conta de médico", "description": { "content": "Rotaciona a chave de API de uma conta de médico, identificada pelo seu `publicId` (`acc_*`) ou `internalCode`. A chave anterior é revogada com uma breve janela de carência; a nova chave em texto puro é retornada **uma única vez** — guarde-a com segurança. Limitado a uma regeneração por conta a cada 2 minutos (`429 rate_limit_exceeded`).", "type": "text/plain" }, "url": { "path": [ "v1", "institutional", "accounts", ":account_id", "api-keys", "regenerate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"validForDays\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Resposta bem-sucedida", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts", ":account_id", "api-keys", "regenerate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"validForDays\": 365\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não autorizado — chave de API ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts", ":account_id", "api-keys", "regenerate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"validForDays\": 365\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Proibido — a chave de API não pode executar esta operação.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts", ":account_id", "api-keys", "regenerate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"validForDays\": 365\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Não encontrado — o recurso solicitado não existe.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts", ":account_id", "api-keys", "regenerate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"validForDays\": 365\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Conflito — o recurso já existe ou está em estado conflitante.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts", ":account_id", "api-keys", "regenerate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"validForDays\": 365\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts", ":account_id", "api-keys", "regenerate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"validForDays\": 365\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Serviço indisponível — uma dependência externa está indisponível.", "originalRequest": { "url": { "path": [ "v1", "institutional", "accounts", ":account_id", "api-keys", "regenerate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"validForDays\": 365\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://scribe-api.telepatia.ai", "key": "baseUrl" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "info": { "name": "Scribe Institutional API (PT-BR)", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "API REST externa para integração com a plataforma Telepatia. Autentique-se com chaves de API, defina o contexto da consulta e busque sessões de scribe.", "type": "text/plain" } } }