KinologydevelopersReferência da API v1.0
CONTRATO PÚBLICO · v1.0

Referência da API

11 operações para conectar pacientes, datas clínicas e relatórios ao seu sistema.

Origem de exemplo: https://api.exemplo.invalid. A documentação descreve o contrato revisado; disponibilidade em ambiente não confirmada.
Baixar OpenAPI 3.1
GETAPI key válida

Listar contas

Método e caminho
GET /v7/integracoes/contas

Retorna até 100 concessões e as permissões de cada conta. Use REFERENCIA_CONTA nas próximas chamadas.

Headers e parâmetros

Authorization: Bearer <API_KEY>. X-Correlation-ID opcional.

    Exemplos de chamada

    cURL
    KIN_BASE_URL=https://api.exemplo.invalid
    curl -X GET "$KIN_BASE_URL/v7/integracoes/contas" \
      -H 'Authorization: Bearer <API_KEY>' \
      -H 'X-Correlation-ID: INTEGRACAO-EXEMPLO-001'

    Resposta · 200

    JSON · resposta sintética
    {
      "status": "success",
      "code": 0,
      "VERSAO_SCHEMA": "1.0",
      "ID_CORRELACAO": "INTEGRACAO-EXEMPLO-001",
      "ID_REQUISICAO": "11111111-1111-4111-8111-111111111111",
      "CONTAS": [
        {
          "REFERENCIA_CONTA": "cta_0123456789abcdef0123456789abcdef",
          "PERMISSOES": [
            "PACIENTES_LER",
            "PACIENTES_ESCREVER",
            "RELATORIOS_LER",
            "RELATORIOS_PDF_LER"
          ]
        }
      ]
    }
    Schema da resposta
    JSON Schema
    {
      "type": "object",
      "properties": {
        "status": {
          "enum": [
            "success"
          ]
        },
        "code": {
          "enum": [
            0
          ]
        },
        "VERSAO_SCHEMA": {
          "enum": [
            "1.0"
          ]
        },
        "ID_CORRELACAO": {
          "type": "string"
        },
        "ID_REQUISICAO": {
          "type": "string",
          "format": "uuid"
        },
        "CONTAS": {
          "type": "array",
          "maxItems": 100,
          "items": {
            "type": "object",
            "properties": {
              "REFERENCIA_CONTA": {
                "type": "string",
                "pattern": "^cta_[a-f0-9]{32}$"
              },
              "PERMISSOES": {
                "type": "array",
                "items": {
                  "enum": [
                    "PACIENTES_LER",
                    "PACIENTES_ESCREVER",
                    "RELATORIOS_LER",
                    "RELATORIOS_PDF_LER"
                  ]
                }
              }
            },
            "required": [
              "REFERENCIA_CONTA",
              "PERMISSOES"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "status",
        "code",
        "VERSAO_SCHEMA",
        "ID_CORRELACAO",
        "ID_REQUISICAO",
        "CONTAS"
      ],
      "additionalProperties": false
    }

    Status e falhas

    400, 401, 403, 404, 408, 409, 413, 415, 422, 429, 503. Leia o guia de falhas e retentativas para exemplos de CODIGO_ERRO. 429/503 retornam Retry-After.

    Ler guia relacionado
    POSTPACIENTES_ESCREVER

    Sincronizar paciente

    Método e caminho
    POST /v7/integracoes/contas/{CONTA}/pacientes/sincronizar

    Versão 0 cria (201); versão atual atualiza (200). Omitir campos na atualização preserva os valores. METADADOS.ID_REFERENCIA_EXTERNA é obrigatório em ambas.

    Headers e parâmetros

    Authorization: Bearer <API_KEY>. X-Correlation-ID opcional. Idempotency-Key obrigatório: 8–100 caracteres [A-Za-z0-9._-]. Content-Type: application/json.

    • CONTA · obrigatório no caminho · string · referência pública opaca.

    Corpo da requisição

    JSON · dados sintéticos
    {
      "VERSAO_REGISTRO": 0,
      "USUARIO_NOME": "Paciente Exemplo",
      "USUARIO_NASCIMENTO": "1990-04-15",
      "USUARIO_SEXO": "M",
      "METADADOS": {
        "ID_REFERENCIA_EXTERNA": "00158"
      }
    }
    Schema da requisição
    JSON Schema
    {
      "type": "object",
      "properties": {
        "VERSAO_REGISTRO": {
          "type": "integer",
          "minimum": 0
        },
        "USUARIO_NOME": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "USUARIO_NASCIMENTO": {
          "type": "string",
          "format": "date",
          "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
        },
        "USUARIO_SEXO": {
          "enum": [
            "M",
            "F"
          ]
        },
        "METADADOS": {
          "type": "object",
          "properties": {
            "ID_REFERENCIA_EXTERNA": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            }
          },
          "required": [
            "ID_REFERENCIA_EXTERNA"
          ],
          "additionalProperties": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200
          },
          "description": "Outras chaves exigem autorização prévia da Kinology; não são filtros genéricos."
        }
      },
      "required": [
        "VERSAO_REGISTRO",
        "METADADOS"
      ],
      "additionalProperties": false,
      "if": {
        "properties": {
          "VERSAO_REGISTRO": {
            "enum": [
              0
            ]
          }
        }
      },
      "then": {
        "required": [
          "USUARIO_NOME",
          "USUARIO_NASCIMENTO",
          "USUARIO_SEXO"
        ]
      }
    }

    Exemplos de chamada

    cURL
    KIN_BASE_URL=https://api.exemplo.invalid
    curl -X POST "$KIN_BASE_URL/v7/integracoes/contas/cta_0123456789abcdef0123456789abcdef/pacientes/sincronizar" \
      -H 'Authorization: Bearer <API_KEY>' \
      -H 'X-Correlation-ID: INTEGRACAO-EXEMPLO-001' \
      -H 'Content-Type: application/json' \
      -H 'Idempotency-Key: INTEGRACAO-CADASTRO-001' \
      --data '{
      "VERSAO_REGISTRO": 0,
      "USUARIO_NOME": "Paciente Exemplo",
      "USUARIO_NASCIMENTO": "1990-04-15",
      "USUARIO_SEXO": "M",
      "METADADOS": {
        "ID_REFERENCIA_EXTERNA": "00158"
      }
    }'

    Resposta · 200 / 201

    JSON · resposta sintética
    {
      "status": "success",
      "code": 0,
      "VERSAO_SCHEMA": "1.0",
      "ID_CORRELACAO": "INTEGRACAO-EXEMPLO-001",
      "ID_REQUISICAO": "11111111-1111-4111-8111-111111111111",
      "PACIENTE": {
        "SITUACAO": "CRIADO",
        "REFERENCIA_PACIENTE": "pac_abcdef0123456789abcdef0123456789",
        "VERSAO_REGISTRO": 1
      }
    }
    Schema da resposta
    JSON Schema
    {
      "type": "object",
      "properties": {
        "status": {
          "enum": [
            "success"
          ]
        },
        "code": {
          "enum": [
            0
          ]
        },
        "VERSAO_SCHEMA": {
          "enum": [
            "1.0"
          ]
        },
        "ID_CORRELACAO": {
          "type": "string"
        },
        "ID_REQUISICAO": {
          "type": "string",
          "format": "uuid"
        },
        "PACIENTE": {
          "type": "object",
          "properties": {
            "SITUACAO": {
              "enum": [
                "CRIADO",
                "ATUALIZADO"
              ]
            },
            "REFERENCIA_PACIENTE": {
              "type": "string",
              "pattern": "^pac_[a-f0-9]{32}$"
            },
            "VERSAO_REGISTRO": {
              "type": "integer",
              "minimum": 1
            }
          },
          "required": [
            "SITUACAO",
            "REFERENCIA_PACIENTE",
            "VERSAO_REGISTRO"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "status",
        "code",
        "VERSAO_SCHEMA",
        "ID_CORRELACAO",
        "ID_REQUISICAO",
        "PACIENTE"
      ],
      "additionalProperties": false
    }

    Status e falhas

    400, 401, 403, 404, 408, 409, 413, 415, 422, 429, 503. Leia o guia de falhas e retentativas para exemplos de CODIGO_ERRO. 429/503 retornam Retry-After.

    Ler guia relacionado
    POSTPACIENTES_ESCREVER

    Importar CSV

    Método e caminho
    POST /v7/integracoes/contas/{CONTA}/pacientes/importar

    Importação síncrona somente de criação. Até 100 registros, 128 KiB decodificados. HTTP 200 indica lote processado; confira RESULTADOS por linha.

    Headers e parâmetros

    Authorization: Bearer <API_KEY>. X-Correlation-ID opcional. Idempotency-Key obrigatório: 8–100 caracteres [A-Za-z0-9._-]. Content-Type: application/json.

    • CONTA · obrigatório no caminho · string · referência pública opaca.

    Corpo da requisição

    JSON · dados sintéticos
    {
      "CSV_BASE64": "SURfUkVGRVJFTkNJQV9FWFRFUk5BLFVTVUFSSU9fTk9NRSxVU1VBUklPX05BU0NJTUVOVE8sVVNVQVJJT19TRVhPCjAwMTU4LCJBbmEsIEV4ZW1wbG8iLDE5OTAtMDQtMTUsRgo="
    }
    Schema da requisição
    JSON Schema
    {
      "type": "object",
      "properties": {
        "CSV_BASE64": {
          "type": "string",
          "contentEncoding": "base64"
        }
      },
      "required": [
        "CSV_BASE64"
      ],
      "additionalProperties": false
    }

    Exemplos de chamada

    cURL
    KIN_BASE_URL=https://api.exemplo.invalid
    curl -X POST "$KIN_BASE_URL/v7/integracoes/contas/cta_0123456789abcdef0123456789abcdef/pacientes/importar" \
      -H 'Authorization: Bearer <API_KEY>' \
      -H 'X-Correlation-ID: INTEGRACAO-EXEMPLO-001' \
      -H 'Content-Type: application/json' \
      -H 'Idempotency-Key: INTEGRACAO-CADASTRO-001' \
      --data '{
      "CSV_BASE64": "SURfUkVGRVJFTkNJQV9FWFRFUk5BLFVTVUFSSU9fTk9NRSxVU1VBUklPX05BU0NJTUVOVE8sVVNVQVJJT19TRVhPCjAwMTU4LCJBbmEsIEV4ZW1wbG8iLDE5OTAtMDQtMTUsRgo="
    }'

    Resposta · 200

    JSON · resposta sintética
    {
      "status": "success",
      "code": 0,
      "VERSAO_SCHEMA": "1.0",
      "ID_CORRELACAO": "INTEGRACAO-EXEMPLO-001",
      "ID_REQUISICAO": "11111111-1111-4111-8111-111111111111",
      "RESUMO": {
        "TOTAL": 2,
        "CRIADOS": 1,
        "JA_CADASTRADOS": 0,
        "REJEITADOS": 1
      },
      "RESULTADOS": [
        {
          "LINHA": 2,
          "ID_REFERENCIA_EXTERNA": "00158",
          "SITUACAO": "CRIADO",
          "REFERENCIA_PACIENTE": "pac_abcdef0123456789abcdef0123456789",
          "VERSAO_REGISTRO": 1
        },
        {
          "LINHA": 3,
          "ID_REFERENCIA_EXTERNA": "00159",
          "SITUACAO": "REJEITADO",
          "CODIGO_ERRO": "DATA_INVALIDA"
        }
      ]
    }
    Schema da resposta
    JSON Schema
    {
      "type": "object",
      "properties": {
        "status": {
          "enum": [
            "success"
          ]
        },
        "code": {
          "enum": [
            0
          ]
        },
        "VERSAO_SCHEMA": {
          "enum": [
            "1.0"
          ]
        },
        "ID_CORRELACAO": {
          "type": "string"
        },
        "ID_REQUISICAO": {
          "type": "string",
          "format": "uuid"
        },
        "RESUMO": {
          "type": "object",
          "properties": {
            "TOTAL": {
              "type": "integer"
            },
            "CRIADOS": {
              "type": "integer"
            },
            "JA_CADASTRADOS": {
              "type": "integer"
            },
            "REJEITADOS": {
              "type": "integer"
            }
          },
          "required": [
            "TOTAL",
            "CRIADOS",
            "JA_CADASTRADOS",
            "REJEITADOS"
          ],
          "additionalProperties": false
        },
        "RESULTADOS": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "LINHA": {
                "type": "integer"
              },
              "ID_REFERENCIA_EXTERNA": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "SITUACAO": {
                "enum": [
                  "CRIADO",
                  "JA_CADASTRADO",
                  "REJEITADO"
                ]
              },
              "REFERENCIA_PACIENTE": {
                "type": "string",
                "pattern": "^pac_[a-f0-9]{32}$"
              },
              "VERSAO_REGISTRO": {
                "type": "integer"
              },
              "CODIGO_ERRO": {
                "type": "string"
              }
            },
            "required": [
              "LINHA",
              "ID_REFERENCIA_EXTERNA",
              "SITUACAO"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "status",
        "code",
        "VERSAO_SCHEMA",
        "ID_CORRELACAO",
        "ID_REQUISICAO",
        "RESUMO",
        "RESULTADOS"
      ],
      "additionalProperties": false
    }

    Status e falhas

    400, 401, 403, 404, 408, 409, 413, 415, 422, 429, 503. Leia o guia de falhas e retentativas para exemplos de CODIGO_ERRO. 429/503 retornam Retry-After.

    Ler guia relacionado
    GETPACIENTES_ESCREVER

    Baixar modelo CSV

    Método e caminho
    GET /v7/integracoes/contas/{CONTA}/pacientes/importar/modelo

    Arquivo text/csv UTF-8 com as quatro colunas obrigatórias.

    Headers e parâmetros

    Authorization: Bearer <API_KEY>. X-Correlation-ID opcional.

    • CONTA · obrigatório no caminho · string · referência pública opaca.

    Exemplos de chamada

    cURL
    KIN_BASE_URL=https://api.exemplo.invalid
    curl -X GET "$KIN_BASE_URL/v7/integracoes/contas/cta_0123456789abcdef0123456789abcdef/pacientes/importar/modelo" \
      -H 'Authorization: Bearer <API_KEY>' \
      -H 'X-Correlation-ID: INTEGRACAO-EXEMPLO-001'

    Resposta · 200

    text/csv
    ID_REFERENCIA_EXTERNA,USUARIO_NOME,USUARIO_NASCIMENTO,USUARIO_SEXO
    00158,"Ana, Exemplo",1990-04-15,F
    

    Status e falhas

    400, 401, 403, 404, 408, 409, 413, 415, 422, 429, 503. Leia o guia de falhas e retentativas para exemplos de CODIGO_ERRO. 429/503 retornam Retry-After.

    Ler guia relacionado
    GETPACIENTES_LER

    Consultar por código externo

    Método e caminho
    GET /v7/integracoes/contas/{CONTA}/pacientes/referencia_externa/{EXTERNA}

    Comparação exata e sensível à caixa. Preserve zeros iniciais e use encodeURIComponent no segmento EXTERNA.

    Headers e parâmetros

    Authorization: Bearer <API_KEY>. X-Correlation-ID opcional.

    • CONTA · obrigatório no caminho · string · referência pública opaca.
    • EXTERNA · obrigatório no caminho · string · código externo exato; use encodeURIComponent.

    Exemplos de chamada

    cURL
    KIN_BASE_URL=https://api.exemplo.invalid
    curl -X GET "$KIN_BASE_URL/v7/integracoes/contas/cta_0123456789abcdef0123456789abcdef/pacientes/referencia_externa/00158" \
      -H 'Authorization: Bearer <API_KEY>' \
      -H 'X-Correlation-ID: INTEGRACAO-EXEMPLO-001'

    Resposta · 200

    JSON · resposta sintética
    {
      "status": "success",
      "code": 0,
      "VERSAO_SCHEMA": "1.0",
      "ID_CORRELACAO": "INTEGRACAO-EXEMPLO-001",
      "ID_REQUISICAO": "11111111-1111-4111-8111-111111111111",
      "PACIENTE": {
        "REFERENCIA_PACIENTE": "pac_abcdef0123456789abcdef0123456789",
        "VERSAO_REGISTRO": 1,
        "USUARIO_NOME": "Paciente Exemplo",
        "USUARIO_NASCIMENTO": "1990-04-15",
        "USUARIO_SEXO": "M",
        "METADADOS": {
          "ID_REFERENCIA_EXTERNA": "00158"
        },
        "CRIADO_EM": "2026-11-18T12:00:00.000Z",
        "ATUALIZADO_EM": "2026-11-18T12:00:00.000Z"
      }
    }
    Schema da resposta
    JSON Schema
    {
      "type": "object",
      "properties": {
        "status": {
          "enum": [
            "success"
          ]
        },
        "code": {
          "enum": [
            0
          ]
        },
        "VERSAO_SCHEMA": {
          "enum": [
            "1.0"
          ]
        },
        "ID_CORRELACAO": {
          "type": "string"
        },
        "ID_REQUISICAO": {
          "type": "string",
          "format": "uuid"
        },
        "PACIENTE": {
          "type": "object",
          "properties": {
            "REFERENCIA_PACIENTE": {
              "type": "string",
              "pattern": "^pac_[a-f0-9]{32}$"
            },
            "VERSAO_REGISTRO": {
              "type": "integer",
              "minimum": 1
            },
            "USUARIO_NOME": {
              "type": "string"
            },
            "USUARIO_NASCIMENTO": {
              "type": [
                "string",
                "null"
              ],
              "format": "date"
            },
            "USUARIO_SEXO": {
              "enum": [
                "M",
                "F",
                null
              ]
            },
            "METADADOS": {
              "type": "object",
              "properties": {
                "ID_REFERENCIA_EXTERNA": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 100
                }
              },
              "required": [
                "ID_REFERENCIA_EXTERNA"
              ],
              "additionalProperties": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "description": "Outras chaves exigem autorização prévia da Kinology; não são filtros genéricos."
            },
            "CRIADO_EM": {
              "type": "string",
              "format": "date-time",
              "pattern": "Z$"
            },
            "ATUALIZADO_EM": {
              "type": "string",
              "format": "date-time",
              "pattern": "Z$"
            }
          },
          "required": [
            "REFERENCIA_PACIENTE",
            "VERSAO_REGISTRO",
            "USUARIO_NOME",
            "USUARIO_NASCIMENTO",
            "USUARIO_SEXO",
            "METADADOS",
            "CRIADO_EM",
            "ATUALIZADO_EM"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "status",
        "code",
        "VERSAO_SCHEMA",
        "ID_CORRELACAO",
        "ID_REQUISICAO",
        "PACIENTE"
      ],
      "additionalProperties": false
    }

    Status e falhas

    400, 401, 403, 404, 408, 409, 413, 415, 422, 429, 503. Leia o guia de falhas e retentativas para exemplos de CODIGO_ERRO. 429/503 retornam Retry-After.

    Ler guia relacionado
    GETPACIENTES_LER

    Consultar por referência pública

    Método e caminho
    GET /v7/integracoes/contas/{CONTA}/pacientes/{PACIENTE}

    REFERENCIA_PACIENTE é opaca. Conhecê-la não concede acesso ao registro.

    Headers e parâmetros

    Authorization: Bearer <API_KEY>. X-Correlation-ID opcional.

    • CONTA · obrigatório no caminho · string · referência pública opaca.
    • PACIENTE · obrigatório no caminho · string · referência pública opaca.

    Exemplos de chamada

    cURL
    KIN_BASE_URL=https://api.exemplo.invalid
    curl -X GET "$KIN_BASE_URL/v7/integracoes/contas/cta_0123456789abcdef0123456789abcdef/pacientes/pac_abcdef0123456789abcdef0123456789" \
      -H 'Authorization: Bearer <API_KEY>' \
      -H 'X-Correlation-ID: INTEGRACAO-EXEMPLO-001'

    Resposta · 200

    JSON · resposta sintética
    {
      "status": "success",
      "code": 0,
      "VERSAO_SCHEMA": "1.0",
      "ID_CORRELACAO": "INTEGRACAO-EXEMPLO-001",
      "ID_REQUISICAO": "11111111-1111-4111-8111-111111111111",
      "PACIENTE": {
        "REFERENCIA_PACIENTE": "pac_abcdef0123456789abcdef0123456789",
        "VERSAO_REGISTRO": 1,
        "USUARIO_NOME": "Paciente Exemplo",
        "USUARIO_NASCIMENTO": "1990-04-15",
        "USUARIO_SEXO": "M",
        "METADADOS": {
          "ID_REFERENCIA_EXTERNA": "00158"
        },
        "CRIADO_EM": "2026-11-18T12:00:00.000Z",
        "ATUALIZADO_EM": "2026-11-18T12:00:00.000Z"
      }
    }
    Schema da resposta
    JSON Schema
    {
      "type": "object",
      "properties": {
        "status": {
          "enum": [
            "success"
          ]
        },
        "code": {
          "enum": [
            0
          ]
        },
        "VERSAO_SCHEMA": {
          "enum": [
            "1.0"
          ]
        },
        "ID_CORRELACAO": {
          "type": "string"
        },
        "ID_REQUISICAO": {
          "type": "string",
          "format": "uuid"
        },
        "PACIENTE": {
          "type": "object",
          "properties": {
            "REFERENCIA_PACIENTE": {
              "type": "string",
              "pattern": "^pac_[a-f0-9]{32}$"
            },
            "VERSAO_REGISTRO": {
              "type": "integer",
              "minimum": 1
            },
            "USUARIO_NOME": {
              "type": "string"
            },
            "USUARIO_NASCIMENTO": {
              "type": [
                "string",
                "null"
              ],
              "format": "date"
            },
            "USUARIO_SEXO": {
              "enum": [
                "M",
                "F",
                null
              ]
            },
            "METADADOS": {
              "type": "object",
              "properties": {
                "ID_REFERENCIA_EXTERNA": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 100
                }
              },
              "required": [
                "ID_REFERENCIA_EXTERNA"
              ],
              "additionalProperties": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "description": "Outras chaves exigem autorização prévia da Kinology; não são filtros genéricos."
            },
            "CRIADO_EM": {
              "type": "string",
              "format": "date-time",
              "pattern": "Z$"
            },
            "ATUALIZADO_EM": {
              "type": "string",
              "format": "date-time",
              "pattern": "Z$"
            }
          },
          "required": [
            "REFERENCIA_PACIENTE",
            "VERSAO_REGISTRO",
            "USUARIO_NOME",
            "USUARIO_NASCIMENTO",
            "USUARIO_SEXO",
            "METADADOS",
            "CRIADO_EM",
            "ATUALIZADO_EM"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "status",
        "code",
        "VERSAO_SCHEMA",
        "ID_CORRELACAO",
        "ID_REQUISICAO",
        "PACIENTE"
      ],
      "additionalProperties": false
    }

    Status e falhas

    400, 401, 403, 404, 408, 409, 413, 415, 422, 429, 503. Leia o guia de falhas e retentativas para exemplos de CODIGO_ERRO. 429/503 retornam Retry-After.

    Ler guia relacionado
    POSTPACIENTES_LER

    Buscar pacientes

    Método e caminho
    POST /v7/integracoes/contas/{CONTA}/pacientes/buscar

    Filtros combinados por E. Instantes UTC: início inclusivo e fim exclusivo. LIMITE padrão 20, máximo 100. Reinicie o cursor ao trocar conta ou filtros.

    Headers e parâmetros

    Authorization: Bearer <API_KEY>. X-Correlation-ID opcional. Content-Type: application/json.

    • CONTA · obrigatório no caminho · string · referência pública opaca.

    Corpo da requisição

    JSON · dados sintéticos
    {
      "FILTROS": {
        "ATUALIZADO_EM_DE": "2026-11-01T00:00:00Z",
        "ATUALIZADO_EM_ATE": "2026-12-01T00:00:00Z"
      },
      "PAGINACAO": {
        "LIMITE": 20,
        "CURSOR": null
      }
    }
    Schema da requisição
    JSON Schema
    {
      "type": "object",
      "properties": {
        "FILTROS": {
          "type": "object",
          "properties": {
            "ID_REFERENCIA_EXTERNA": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            },
            "CRIADO_EM_DE": {
              "type": "string",
              "format": "date-time",
              "pattern": "Z$"
            },
            "CRIADO_EM_ATE": {
              "type": "string",
              "format": "date-time",
              "pattern": "Z$"
            },
            "ATUALIZADO_EM_DE": {
              "type": "string",
              "format": "date-time",
              "pattern": "Z$"
            },
            "ATUALIZADO_EM_ATE": {
              "type": "string",
              "format": "date-time",
              "pattern": "Z$"
            }
          },
          "required": [],
          "additionalProperties": false
        },
        "PAGINACAO": {
          "type": "object",
          "properties": {
            "LIMITE": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100
            },
            "CURSOR": {
              "type": [
                "string",
                "null"
              ],
              "maxLength": 3000
            }
          },
          "required": [],
          "additionalProperties": false
        }
      },
      "required": [],
      "additionalProperties": false
    }

    Exemplos de chamada

    cURL
    KIN_BASE_URL=https://api.exemplo.invalid
    curl -X POST "$KIN_BASE_URL/v7/integracoes/contas/cta_0123456789abcdef0123456789abcdef/pacientes/buscar" \
      -H 'Authorization: Bearer <API_KEY>' \
      -H 'X-Correlation-ID: INTEGRACAO-EXEMPLO-001' \
      -H 'Content-Type: application/json' \
      --data '{
      "FILTROS": {
        "ATUALIZADO_EM_DE": "2026-11-01T00:00:00Z",
        "ATUALIZADO_EM_ATE": "2026-12-01T00:00:00Z"
      },
      "PAGINACAO": {
        "LIMITE": 20,
        "CURSOR": null
      }
    }'

    Resposta · 200

    JSON · resposta sintética
    {
      "status": "success",
      "code": 0,
      "VERSAO_SCHEMA": "1.0",
      "ID_CORRELACAO": "INTEGRACAO-EXEMPLO-001",
      "ID_REQUISICAO": "11111111-1111-4111-8111-111111111111",
      "PACIENTES": [
        {
          "REFERENCIA_PACIENTE": "pac_abcdef0123456789abcdef0123456789",
          "VERSAO_REGISTRO": 1,
          "USUARIO_NOME": "Paciente Exemplo",
          "USUARIO_NASCIMENTO": "1990-04-15",
          "USUARIO_SEXO": "M",
          "METADADOS": {
            "ID_REFERENCIA_EXTERNA": "00158"
          },
          "CRIADO_EM": "2026-11-18T12:00:00.000Z",
          "ATUALIZADO_EM": "2026-11-18T12:00:00.000Z"
        }
      ],
      "PAGINACAO": {
        "PROXIMO_CURSOR": null,
        "TEM_MAIS": "N"
      }
    }
    Schema da resposta
    JSON Schema
    {
      "type": "object",
      "properties": {
        "status": {
          "enum": [
            "success"
          ]
        },
        "code": {
          "enum": [
            0
          ]
        },
        "VERSAO_SCHEMA": {
          "enum": [
            "1.0"
          ]
        },
        "ID_CORRELACAO": {
          "type": "string"
        },
        "ID_REQUISICAO": {
          "type": "string",
          "format": "uuid"
        },
        "PACIENTES": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "REFERENCIA_PACIENTE": {
                "type": "string",
                "pattern": "^pac_[a-f0-9]{32}$"
              },
              "VERSAO_REGISTRO": {
                "type": "integer",
                "minimum": 1
              },
              "USUARIO_NOME": {
                "type": "string"
              },
              "USUARIO_NASCIMENTO": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "date"
              },
              "USUARIO_SEXO": {
                "enum": [
                  "M",
                  "F",
                  null
                ]
              },
              "METADADOS": {
                "type": "object",
                "properties": {
                  "ID_REFERENCIA_EXTERNA": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100
                  }
                },
                "required": [
                  "ID_REFERENCIA_EXTERNA"
                ],
                "additionalProperties": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200
                },
                "description": "Outras chaves exigem autorização prévia da Kinology; não são filtros genéricos."
              },
              "CRIADO_EM": {
                "type": "string",
                "format": "date-time",
                "pattern": "Z$"
              },
              "ATUALIZADO_EM": {
                "type": "string",
                "format": "date-time",
                "pattern": "Z$"
              }
            },
            "required": [
              "REFERENCIA_PACIENTE",
              "VERSAO_REGISTRO",
              "USUARIO_NOME",
              "USUARIO_NASCIMENTO",
              "USUARIO_SEXO",
              "METADADOS",
              "CRIADO_EM",
              "ATUALIZADO_EM"
            ],
            "additionalProperties": false
          }
        },
        "PAGINACAO": {
          "type": "object",
          "properties": {
            "PROXIMO_CURSOR": {
              "type": [
                "string",
                "null"
              ]
            },
            "TEM_MAIS": {
              "enum": [
                "S",
                "N"
              ]
            }
          },
          "required": [
            "PROXIMO_CURSOR",
            "TEM_MAIS"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "status",
        "code",
        "VERSAO_SCHEMA",
        "ID_CORRELACAO",
        "ID_REQUISICAO",
        "PACIENTES",
        "PAGINACAO"
      ],
      "additionalProperties": false
    }

    Status e falhas

    400, 401, 403, 404, 408, 409, 413, 415, 422, 429, 503. Leia o guia de falhas e retentativas para exemplos de CODIGO_ERRO. 429/503 retornam Retry-After.

    Ler guia relacionado
    GETRELATORIOS_LER

    Consultar datas clínicas

    Método e caminho
    GET /v7/integracoes/contas/{CONTA}/pacientes/referencia_externa/{EXTERNA}/relatorios/datas

    As 20 datas mais recentes, em ordem decrescente. DATA_DE e DATA_ATE inclusivas. DATAS vazio indica ausência de dados na projeção atual; sua atualização pode ter atraso.

    Headers e parâmetros

    Authorization: Bearer <API_KEY>. X-Correlation-ID opcional.

    • CONTA · obrigatório no caminho · string · referência pública opaca.
    • EXTERNA · obrigatório no caminho · string · código externo exato; use encodeURIComponent.
    • DATA_DE · query opcional · YYYY-MM-DD inclusivo.
    • DATA_ATE · query opcional · YYYY-MM-DD inclusivo.
    • CURSOR · query opcional · cursor opaco da página anterior.

    Exemplos de chamada

    cURL
    KIN_BASE_URL=https://api.exemplo.invalid
    curl -X GET "$KIN_BASE_URL/v7/integracoes/contas/cta_0123456789abcdef0123456789abcdef/pacientes/referencia_externa/00158/relatorios/datas" \
      -H 'Authorization: Bearer <API_KEY>' \
      -H 'X-Correlation-ID: INTEGRACAO-EXEMPLO-001'

    Resposta · 200

    JSON · resposta sintética
    {
      "status": "success",
      "code": 0,
      "VERSAO_SCHEMA": "1.0",
      "ID_CORRELACAO": "INTEGRACAO-EXEMPLO-001",
      "ID_REQUISICAO": "11111111-1111-4111-8111-111111111111",
      "DATAS": [
        {
          "DATA": "2026-11-18",
          "SECOES_DISPONIVEIS": [
            "ANAMNESE",
            "EVA"
          ]
        }
      ],
      "PROXIMO_CURSOR": null
    }
    Schema da resposta
    JSON Schema
    {
      "type": "object",
      "properties": {
        "status": {
          "enum": [
            "success"
          ]
        },
        "code": {
          "enum": [
            0
          ]
        },
        "VERSAO_SCHEMA": {
          "enum": [
            "1.0"
          ]
        },
        "ID_CORRELACAO": {
          "type": "string"
        },
        "ID_REQUISICAO": {
          "type": "string",
          "format": "uuid"
        },
        "DATAS": {
          "type": "array",
          "maxItems": 20,
          "items": {
            "type": "object",
            "properties": {
              "DATA": {
                "type": "string",
                "format": "date",
                "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
              },
              "SECOES_DISPONIVEIS": {
                "type": "array",
                "items": {
                  "enum": [
                    "TRIAGEM",
                    "ANAMNESE",
                    "ATENDIMENTO",
                    "PREENSAO_PALMAR",
                    "ASSIMETRIA",
                    "EQUILIBRIO_MUSCULAR",
                    "EVA",
                    "SF_36",
                    "PROGRESSAO_FORCA",
                    "CURVAS_FORCA"
                  ]
                }
              }
            },
            "required": [
              "DATA",
              "SECOES_DISPONIVEIS"
            ],
            "additionalProperties": false
          }
        },
        "PROXIMO_CURSOR": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "status",
        "code",
        "VERSAO_SCHEMA",
        "ID_CORRELACAO",
        "ID_REQUISICAO",
        "DATAS",
        "PROXIMO_CURSOR"
      ],
      "additionalProperties": false
    }

    Status e falhas

    400, 401, 403, 404, 408, 409, 413, 415, 422, 429, 503. Leia o guia de falhas e retentativas para exemplos de CODIGO_ERRO. 429/503 retornam Retry-After.

    Ler guia relacionado
    POSTRELATORIOS_PDF_LER

    Solicitar PDF

    Método e caminho
    POST /v7/integracoes/contas/{CONTA}/pacientes/referencia_externa/{EXTERNA}/relatorios/pdf

    Período de até 31 dias inclusivos e seções válidas sem duplicatas. 409 PDF_EM_GERACAO indica pedido pendente: retente o mesmo pedido com espera limitada. Gera ou reaproveita PDF equivalente. EXPIRA_EM é a fonte de verdade: até sete dias, podendo vencer antes.

    Headers e parâmetros

    Authorization: Bearer <API_KEY>. X-Correlation-ID opcional. Content-Type: application/json.

    • CONTA · obrigatório no caminho · string · referência pública opaca.
    • EXTERNA · obrigatório no caminho · string · código externo exato; use encodeURIComponent.

    Corpo da requisição

    JSON · dados sintéticos
    {
      "PERIODO": {
        "INICIO": "2026-11-18",
        "FIM": "2026-11-18"
      },
      "SECOES": [
        "ANAMNESE",
        "EVA"
      ]
    }
    Schema da requisição
    JSON Schema
    {
      "type": "object",
      "properties": {
        "PERIODO": {
          "type": "object",
          "properties": {
            "INICIO": {
              "type": "string",
              "format": "date",
              "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
            },
            "FIM": {
              "type": "string",
              "format": "date",
              "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
            }
          },
          "required": [
            "INICIO",
            "FIM"
          ],
          "additionalProperties": false,
          "description": "Início e fim inclusivos; até 31 dias."
        },
        "SECOES": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "TRIAGEM",
              "ANAMNESE",
              "ATENDIMENTO",
              "PREENSAO_PALMAR",
              "ASSIMETRIA",
              "EQUILIBRIO_MUSCULAR",
              "EVA",
              "SF_36",
              "PROGRESSAO_FORCA",
              "CURVAS_FORCA"
            ]
          },
          "minItems": 1,
          "maxItems": 10,
          "uniqueItems": true
        }
      },
      "required": [
        "PERIODO",
        "SECOES"
      ],
      "additionalProperties": false
    }

    Exemplos de chamada

    cURL
    KIN_BASE_URL=https://api.exemplo.invalid
    curl -X POST "$KIN_BASE_URL/v7/integracoes/contas/cta_0123456789abcdef0123456789abcdef/pacientes/referencia_externa/00158/relatorios/pdf" \
      -H 'Authorization: Bearer <API_KEY>' \
      -H 'X-Correlation-ID: INTEGRACAO-EXEMPLO-001' \
      -H 'Content-Type: application/json' \
      --data '{
      "PERIODO": {
        "INICIO": "2026-11-18",
        "FIM": "2026-11-18"
      },
      "SECOES": [
        "ANAMNESE",
        "EVA"
      ]
    }'

    Resposta · 200

    JSON · resposta sintética
    {
      "status": "success",
      "code": 0,
      "VERSAO_SCHEMA": "1.0",
      "ID_CORRELACAO": "INTEGRACAO-EXEMPLO-001",
      "ID_REQUISICAO": "11111111-1111-4111-8111-111111111111",
      "REFERENCIA_RELATORIO": "pdf_0123456789abcdef0123456789abcdef",
      "URL_PDF": "https://api.exemplo.invalid/v7/integracoes/documentos/acesso/solicitado/TICKET_SINTETICO_NAO_UTILIZAVEL",
      "EXPIRA_EM": "2026-11-25T12:00:00.000Z"
    }
    Schema da resposta
    JSON Schema
    {
      "type": "object",
      "properties": {
        "status": {
          "enum": [
            "success"
          ]
        },
        "code": {
          "enum": [
            0
          ]
        },
        "VERSAO_SCHEMA": {
          "enum": [
            "1.0"
          ]
        },
        "ID_CORRELACAO": {
          "type": "string"
        },
        "ID_REQUISICAO": {
          "type": "string",
          "format": "uuid"
        },
        "REFERENCIA_RELATORIO": {
          "type": "string",
          "pattern": "^pdf_[a-f0-9]{32}$"
        },
        "URL_PDF": {
          "type": "string",
          "format": "uri"
        },
        "EXPIRA_EM": {
          "type": "string",
          "format": "date-time",
          "pattern": "Z$"
        }
      },
      "required": [
        "status",
        "code",
        "VERSAO_SCHEMA",
        "ID_CORRELACAO",
        "ID_REQUISICAO",
        "REFERENCIA_RELATORIO",
        "URL_PDF",
        "EXPIRA_EM"
      ],
      "additionalProperties": false
    }

    Status e falhas

    400, 401, 403, 404, 408, 409, 413, 415, 422, 429, 503. Leia o guia de falhas e retentativas para exemplos de CODIGO_ERRO. 429/503 retornam Retry-After. 422: SEM_DADOS_PDF, SECAO_INDISPONIVEL ou VOLUME_EXCEDIDO.

    Ler guia relacionado
    GETTicket válido e escopo revalidado

    Abrir link temporário

    Método e caminho
    GET /v7/integracoes/documentos/acesso/solicitado/{TOKEN}

    Abra URL_PDF diretamente e permita redirecionamentos. Sem Bearer. Retorna 302, Cache-Control: private, no-store e Referrer-Policy: no-referrer. Ticket é segredo temporário; mantenha fora de logs, analytics e armazenamento persistente.

    Headers e parâmetros

    Sem Bearer. TOKEN é o segredo temporário retornado em URL_PDF.

    • TOKEN · obrigatório no caminho · string · segredo temporário, não registrar.

    Exemplos de chamada

    cURL
    KIN_BASE_URL=https://api.exemplo.invalid
    curl -L -X GET "$KIN_BASE_URL/v7/integracoes/documentos/acesso/solicitado/TICKET_SINTETICO_NAO_UTILIZAVEL"

    Resposta · 302

    HTTP · redirecionamento
    HTTP 302
    Location: https://example.invalid/pdf-sintetico.pdf
    Cache-Control: private, no-store
    Referrer-Policy: no-referrer

    Status e falhas

    400, 401, 403, 404, 408, 409, 413, 415, 422, 429, 503. Leia o guia de falhas e retentativas para exemplos de CODIGO_ERRO. 429/503 retornam Retry-After.

    Ler guia relacionado