Webhook

Endpoint de resposta para recebimento das receitas renovadas

Será necessário configurar um enpoint para recebimento das receitas após a renovação. O endpoint deverá utilizar os padrões REST e HTTPS com verbo POST

Será necessário nos enviar:

• Endpoint [POST]

• headerKey

• headerSecret

Exemplo de endpoint:

[POST] https://otica.com.br/renovacoes

O Content-type do POST será no formato: "application/json"

Valores de autenticação:

headerKey: Chave a ser enviada no header do POST.

• Exemplo: api-key , x-api-key ou valor customizado

headerSecret: Chave secreta a ser enviada como value do headerKey.

• Exemplo: "API_KEY_SECRETA"

Exemplo de payload enviado:

{
    "email": "[email protected]",
    "cpf": "99999999999",
    "status": "renewed",
    "reason": null,
    "eyeMeasurements": {
        "right": {
            "spherical": -0.75,
            "cylindrical": 0,
            "axis": 0,
            "add": 0
        },
        "left": {
            "spherical": -0.75,
            "cylindrical": 0,
            "axis": 0,
            "add": 0
        }
    },
    "files": [
        {
            "fileName": "Prescrição de óculos",
            "fileUrl": "https://.../document.pdf"
        },
        {
            "fileName": "Prescrição de lentes de contato",
            "fileUrl": "https://.../document.pdf"
        }
    ],
    "partnerParams": {}
}

Detalhamento dos campos:

Campo	Tipo	Descrição
email	string	Email do cliente
cpf	string	CPF do cliente
status	enum [pending, in_analysis, rejected, renewed]	Status da pendência
reason	string	Motivo quando a renovação for recusada
eyeMeasurements	object	Valores da receita enviada pelo cliente/paciente
files	array	Objeto contendo até duas receitas renovadas, podendo ser prescrição de óculos e/ou prescrição de lentes de contato
partnerParams	object	Propriedades customizadas adicionadas no token inicial

As informações sobre o webhook devem ser passadas para o nosso time de tecnologia.