Como consumir API de CPF em Mendix com microflows e REST

Nome: CPFHub_Service
Base URL: https://api.cpfhub.io

-- Adicionar HTTP Header
Header Name: x-api-key
Value: (Constante) CPFHub_APIKey

Header Name: Accept
Value: application/json

Nome da Operação: ValidateCPF
HTTP Method: GET
Location: /cpf/{CPFNumber}

-- Parâmetro de URL
Nome: CPFNumber
Tipo: String

-- Timeout
Request Timeout: 10000 (milissegundos)

Entity: CPFResponse
    Attributes:
    - Success (Boolean)

    Association:
    - CPFResponse_CPFData (1-to-1)

Entity: CPFData
    Attributes:
    - CPF (String, 11)
    - Name (String, 200)
    - NameUpper (String, 200)
    - Gender (String, 1)
    - BirthDate (String, 10)
    - Day (String, 2)
    - Month (String, 2)
    - Year (String, 4)

{
    "success": true,
    "data": {
    "cpf": "12345678909",
    "name": "NOME COMPLETO",
    "nameUpper": "NOME COMPLETO",
    "gender": "M",
    "birthDate": "01/01/1990",
    "day": "01",
    "month": "01",
    "year": "1990"
    }
}

Microflow: MF_ValidateCPF

Input Parameters:
    - CPFInput (String)

Return Type: CPFValidationResult (Non-persistent entity)

Flow:

1. [Create Variable]
    CleanCPF = replaceAll(replaceAll(replaceAll($CPFInput, '.', ''), '-', ''), ' ', '')

2. [Decision] length($CleanCPF) = 11
    False ->
    [Create Object] CPFValidationResult
    IsValid = false
    ErrorMessage = 'CPF deve conter 11 dígitos.'
    [End Event] Return CPFValidationResult

3. [Call REST Service] CPFHub_Service.ValidateCPF
    CPFNumber = $CleanCPF
    -- Store response in: $RESTResponse

4. [Decision] $RESTResponse/Success = true
    True ->
    [Create Object] CPFValidationResult
    IsValid = true
    Name = $RESTResponse/CPFResponse_CPFData/CPFData/Name
    BirthDate = $RESTResponse/CPFResponse_CPFData/CPFData/BirthDate
    Gender = $RESTResponse/CPFResponse_CPFData/CPFData/Gender

    False ->
    [Create Object] CPFValidationResult
    IsValid = false
    ErrorMessage = 'CPF não encontrado na base de dados.'

5. [End Event] Return CPFValidationResult

Error Handler (Custom):
    [Create Object] CPFValidationResult
    IsValid = false
    ErrorMessage = 'Erro ao validar CPF. Tente novamente.'
    [End Event] Return CPFValidationResult

Entity: CPFValidationResult (Non-persistent)
    Attributes:
    - IsValid (Boolean)
    - Name (String, 200)
    - BirthDate (String, 10)
    - Gender (String, 1)
    - ErrorMessage (String, 500)

Page: CPF_Validation_Page

Layout:
    LayoutGrid (2 columns)
    Column 1:
    DataView (DataSource: CPFValidationInput object)
    |-- TextBox: CPF
    | Placeholder: "000.000.000-00"
    |
    |-- ActionButton: "Validar CPF"
    | On Click: Call Microflow MF_ValidateCPF_FromPage

    Column 2:
    DataView (DataSource: CPFValidationResult)
    Visibility: $Result/IsValid = true
    |-- TextBox (ReadOnly): Nome -> $Result/Name
    |-- TextBox (ReadOnly): Data de Nascimento -> $Result/BirthDate
    |-- TextBox (ReadOnly): Gênero -> $Result/Gender

    Container (Error Feedback)
    Visibility: $Result/IsValid = false AND $Result/ErrorMessage != empty
    |-- Text: $Result/ErrorMessage
    |-- Class: alert-danger

Nanoflow: NF_FormatCPF

Input: CPFValue (String)
Output: FormattedCPF (String)

Flow:
1. [JavaScript Action]

// Código JavaScript dentro do JavaScript Action
var digits = $CPFValue.replace(/\D/g, '').slice(0, 11);
var formatted = digits;

if (digits.length > 9) {
    formatted = digits.replace(
    /(\d{3})(\d{3})(\d{3})(\d{1,2})/,
    '$1.$2.$3-$4'
    );
} else if (digits.length > 6) {
    formatted = digits.replace(
    /(\d{3})(\d{3})(\d{1,3})/,
    '$1.$2.$3'
    );
} else if (digits.length > 3) {
    formatted = digits.replace(
    /(\d{3})(\d{1,3})/,
    '$1.$2'
    );
}

return formatted;

Constant: CPFHub_APIKey
    Type: String
    Default Value: SUA_CHAVE_DE_API

-- Configure valores por ambiente via Mendix Developer Portal:
-- Development: chave de teste
-- Acceptance: chave de staging
-- Production: chave de produção

Microflow: MF_LogCPFQuery

Input: CPF (String), Success (Boolean), ResponseName (String)

Flow:
1. [Create Object] CPFQueryLog
    - CPFMasked = substring($CPF, 0, 3) + '****' + substring($CPF, 9, 2)
    - Success = $Success
    - ResponseName = $ResponseName
    - UserName = $currentSession/User/Name
    - Timestamp = [%CurrentDateTime%]

2. [Commit Object] CPFQueryLog

// JavaScript Action: JS_ValidateCPFDigits
function validateCPF(cpf) {
    var digits = cpf.replace(/\D/g, "");
    if (digits.length !== 11) return false;
    if (/^(\d)\1{10}$/.test(digits)) return false;

    var sum = 0;
    for (var i = 0; i < 9; i++) {
    sum += parseInt(digits.charAt(i)) * (10 - i);
    }
    var remainder = (sum * 10) % 11;
    if (remainder === 10) remainder = 0;
    if (remainder !== parseInt(digits.charAt(9))) return false;

    sum = 0;
    for (var i = 0; i < 10; i++) {
    sum += parseInt(digits.charAt(i)) * (11 - i);
    }
    remainder = (sum * 10) % 11;
    if (remainder === 10) remainder = 0;
    return remainder === parseInt(digits.charAt(10));
}

return validateCPF($CPFValue);