sintezy / sdk
SDK oficial para integração com a plataforma Sintezy
0.2.0
2026-09-20 23:54 UTC
Requires
- php: >=8.0
- ext-curl: *
- ext-json: *
Requires (Dev)
None
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
SDK oficial para integração com a plataforma Sintezy.
Instalação
composer require sintezy/sdk
Uso Rápido
<?php require_once 'vendor/autoload.php'; use Sintezy\SintezySDK; // 1. Inicializar a SDK $sdk = new SintezySDK([ 'clientId' => 'seu-client-id', 'clientSecret' => 'seu-client-secret', ]); // 2. Criar uma consulta (autenticação é automática) $appointment = $sdk->createAppointment([ 'userEmail' => 'medico@clinica.com', 'userName' => 'Dr. João Silva', 'layout' => [ 'fields' => [ ['name' => 'Queixa Principal', 'content' => 'inserir aqui a queixa principal', 'position' => 0], ['name' => 'História da Doença Atual', 'content' => 'inserir aqui a história', 'position' => 1], ['name' => 'Exame Físico', 'content' => 'inserir aqui os exames', 'position' => 2], ['name' => 'Diagnóstico', 'content' => 'inserir aqui o diagnóstico', 'position' => 3], ['name' => 'Conduta', 'content' => 'inserir aqui a conduta', 'position' => 4], ] ] ]); // 3. Abrir portal para gravação echo "Portal URL: " . $appointment->portalUrl . "\n"; // O médico grava a consulta no portal // 4. Após finalizar, buscar o documento principal $documento = $sdk->getDocument($appointment->secureId, 'document'); // 5. Gerar outros documentos $receita = $sdk->generateDocument($appointment->secureId, 'prescription'); $atestado = $sdk->generateDocument($appointment->secureId, 'certificate');
Métodos Disponíveis
Autenticação
| Método | Descrição |
|---|---|
authenticate() |
Autentica usando Client Credentials (OAuth 2.0). Chamado automaticamente. |
isAuthenticated() |
Verifica se há um token válido |
Consultas (Appointments)
| Método | Descrição |
|---|---|
createAppointment($params) |
Cria uma nova consulta e retorna a URL do portal |
getAppointment($secureId) |
Busca uma consulta pelo ID |
deleteAppointment($secureId) |
Exclui uma consulta (soft delete) |
Documentos
| Método | Descrição |
|---|---|
generateDocument($secureId, $tipoOuParams) |
Gera um documento de uma consulta finalizada |
getDocument($secureId, $tipo) |
Busca um documento já gerado |
listDocuments($secureId) |
Lista os documentos e quais já existem |
Transcrição e assinatura
| Método | Descrição |
|---|---|
getTranscription($secureId) |
Transcrição da consulta, após a gravação |
getSubscriptionStatus($email) |
Status da assinatura do médico (API keys reseller) |
Tipos de Documento
| Tipo | Descrição |
|---|---|
document |
Prontuário/Documento principal (gerado automaticamente ao finalizar) |
anamnese_summary |
Resumo de anamnese |
clinic_summary |
Resumo clínico |
referral |
Encaminhamento |
exames_call |
Solicitação de exames |
prescription |
Receita médica |
certificate |
Atestado médico |
inss_report |
Laudo INSS |
Documentos com o seu prompt
Além dos tipos acima, você pode escrever o próprio prompt do documento, com os mesmos dois textos que o médico preenche no portal da Sintezy:
contextualization: objetivo do documento, tom esperado, regras e informações obrigatórias.format: como o texto deve aparecer, com seções, quebras de linha, título e assinatura.
Os dois são sempre obrigatórios juntos. Nada do que você envia fica cadastrado na Sintezy: reenvie o prompt a cada geração.
// Tipo do catálogo com o SEU prompt. // Continua sendo clinic_summary e é buscado por esse tipo. $sdk->generateDocument($secureId, [ 'documentType' => 'clinic_summary', 'contextualization' => 'Explique a consulta ao paciente em linguagem simples...', 'format' => "RESUMO DA CONSULTA\n\nOlá, [NOME]...", ]); // Documento que não é de nenhum tipo do catálogo: o documentType vira o NOME // que você dá a ele, e a busca depois é por esse nome. $sdk->generateDocument($secureId, [ 'documentType' => 'carta_alta', 'contextualization' => '...', 'format' => '...', ]); $carta = $sdk->getDocument($secureId, 'carta_alta'); // Sem documentType, o documento é gravado com o nome `custom`. $sdk->generateDocument($secureId, ['contextualization' => '...', 'format' => '...']); $custom = $sdk->getDocument($secureId, 'custom');
Regras que valem a pena saber:
- Um documento por nome, por consulta. Regerar com o mesmo
documentTypesubstitui o anterior; nomes diferentes convivem. - O nome aceita
a-z,0-9,_e-, até 64 caracteres. - A anamnese principal (
document) segue o layout da consulta e não aceita prompt próprio. - A consulta precisa estar finalizada.
- Use sempre
$documento->typeda resposta para buscar depois.
Requisitos
- PHP 8.0 ou superior
- Extensão cURL
- Extensão JSON
Licença
MIT