Buscar cliente

Introdução

A API PNA Member LATAM Pass é a forma pela qual os nossos parceiros podem ter acesso aos dados de nossos clientes LATAM Pass de acordo com as Leis de Proteção de Dados Pessoais dos países em que operamos e tendo sido considerados imprescindíveis para a devida operação da parceria.

Para poder realizar requisições à API, deve-se primeiro obter o token de acesso. Consulte a documentação Autenticação para todas as informações.

Requisição

Há três possibilidades de buscar um cliente:

  1. Apenas por código de identificação do cliente LATAM Pass ou Frequent Flyer Number (ffn);
  2. Apenas por dados do documento de identificação (document);
  3. Primeiro por ffn e depois por document.

Cabeçalho

  • client_id: valor obtido a partir do menu Dev Tools > Minhas Apps > Client ID e obrigatório em todas as requisições
  • access_token: token de acesso obtido anteriormente
  • x-scope: lista de scopes separados por vírgula (,)
  • x-latam-test: fixo LatamPass, a ser utilizado apenas em ambiente de teste, ou seja, não deve ser utilizado em ambiente de produção

Scopes

Os dados dos clientes serão retornados se, e somente se, forem imprescindíveis para a devida operação da parceria. Se forem considerados pessoais ou sensíveis, deverão estar consentidos pelo cliente e respaldados por contrato e/ou termos e condições do programa ou da parceria, a ser definido por Data Protect.

  • Genéricos:
    • member-balance: saldo em conta de pontos resgatáveis
    • member-coalition: coalização do programa
    • member-enrollment: data de inscrição no programa
    • member-language: idioma(s) do cliente
    • member-segment: segmento(s) vinculado(s) à conta
    • member-status: status da conta
    • member-tier: categoria no programa e suas vigências
  • Pessoais ou sensíveis:
    • member-address: endereço(s) do cliente, residência e/ou comercial
    • member-birthdate: data de nascimento do cliente
    • member-document: documento(s) vinculado(s) à conta
    • member-email: endereço(s) de e-mail vinculado(s) à conta
    • member-gender: sexo do cliente
    • member-marital: estado civil do cliente
    • member-name: nomes do cliente
    • member-nationality: nacionalidade do cliente
    • member-phone: número(s) de telefone do cliente, fixou e/ou móvel

Resposta

Erros mais comuns

Escopo inválido, ou não configurado para o cliente

{
  "error": {
    "code": "INVALID_SCOPE",
    "message": "Invalid scopes [member-xx], The provided scope is not allowed.",
    "instructions": "Contact Latam team, to get allowed scopes."
  }
}

Não foi encontrado um cliente com os dados informados

"error": {
   "code": "MEMBER_NOT_EXISTS",
   "message": "MemberDoesNotExist: Member does not exist.",
   "instructions": "Try with other FFN",
   "issuedDateTime": "2024-10-21T18:38:00.101662Z",
   "details": null
}

Campos obrigatórios ausentes ou valores inválidos

"error": {
    "code": "METHOD_ARGUMENT_NOT_VALID",
    "message": "MethodArgumentNotValid: Invalid request for one or more fields",
    "instructions": "Please see the details and retry the request",
    "issuedDateTime": "2024-10-21T18:55:08.950649Z",
    "details": {
        "member.ffn": "must not be null"
    }
}

Documentação técnica

Clique aqui para acessá-la.