fbpx

Chamada de API getMember

A chamada da API getMember é usada para recuperar informações sobre a conta de um membro existente.

Exemplo de URL de solicitação

http://{Your_API_URL}?q=/getMember

Parâmetros de entrada
ParâmetroDescriçãoNecessário
apikeyChave de API de Credenciais da API do MemberMouseSim
apisecretSegredo da API de Credenciais da API do MemberMouseSim
member_idID do membro a ser recuperadoSim, se o endereço de e-mail não for fornecido
e-mailEndereço de e-mail do membro a ser recuperadoSim, se o ID do membro não for fornecido
Códigos de resposta
  • 200 - Sucesso
  • 409 - Não foi possível encontrar o membro com a ID de membro ou o endereço de e-mail informado
Dados de resposta
ParâmetroDescrição
member_idO ID do membro no MemberMouse
primeiro_nomeO primeiro nome do membro
sobrenomeO sobrenome do membro
registradoA data em que o membro se registrou
data_de_cancelamentoA data em que a conta do associado será cancelada. Isso só será definido se o status da conta do membro for cancelamento pendente.
last_logged_inA data em que o membro fez o último login
last_updatedA data em que a conta do membro foi atualizada pela última vez
dias_como_membroO número de dias em que o membro é membro
statusO status da conta do associado. 1 (Ativo), 2 (Cancelado), 3 (Bloqueado), 4 (Pausado), 5 (Vencido), 6 (Ativação pendente), 7 (Erro), 8 (Expirado), 9 (Cancelamento pendente)
nome_do_statusO nome do status na conta do membro.
is_complimentaryIndica se a conta do membro é complementar ou não. Será definido como verdadeiro se a conta for complementar e falso se não for.
nível de associaçãoA ID do nível de associação do membro
nome do nível de associaçãoO nome do nível de associação do membro
nome de usuárioO nome de usuário do membro
e-mailO endereço de e-mail do membro
telefoneO número de telefone do membro
endereço de cobrançaO endereço de cobrança do associado
cidade_de_faturamentoA cidade de cobrança do associado
billing_stateO estado de faturamento do associado
billing_zipO código postal de cobrança do associado
país_de_faturamentoO país de cobrança do membro
endereço_de_envioO endereço de entrega do membro
cidade_de_envioA cidade de embarque do membro
shipping_stateO estado de envio do membro
CEP de remessaCódigo postal de envio do membro
país_de_envioO país de envio do membro
feixesUma matriz de pacotes aplicados à conta do membro. Consulte a tabela abaixo para obter os parâmetros disponíveis para cada pacote.
campos_personalizadosUma matriz de campos personalizados associados à conta do membro. Consulte a tabela abaixo para obter os parâmetros disponíveis para cada campo personalizado.
Dados do pacote

Os dados do pacote são armazenados como uma matriz de itens no atributo bundles como parte dos dados de resposta. Os dados só serão retornados para os pacotes que estiverem ativos na conta do membro. A tabela abaixo descreve os parâmetros retornados para cada item na matriz de pacotes.

ParâmetroDescrição
idO ID do pacote aplicado à conta do membro
nomeO nome do pacote aplicado à conta do membro
dias_com_bundleO número de dias em que o pacote foi aplicado à conta do associado
statusO status numérico do pacote aplicado à conta do associado. O valor pode ser qualquer um dos seguintes: 1 (Ativo), 4 (Em pausa), 9 (Cancelamento pendente)
nome_do_statusO nome do status do pacote aplicado à conta do membro.
is_complimentaryIndica se o pacote é gratuito ou não. Será definido como true se o pacote for complementar e false se não for.
data_adicionadaA data em que o pacote foi aplicado pela primeira vez à conta do associado
last_updatedA data em que o pacote foi atualizado pela última vez na conta do membro
Dados do campo personalizado

Os dados do campo personalizado são armazenados como uma matriz de itens no atributo custom_field como parte dos dados de resposta. A tabela abaixo descreve os parâmetros disponíveis para cada item na matriz de campos personalizados.

ParâmetroDescrição
idA ID do campo personalizado
nomeO nome do campo personalizado
valorO valor armazenado no campo personalizado na conta do membro
Este artigo foi útil?

Artigos relacionados

Não consegue encontrar a resposta que está procurando?

Entre em contato com nossa Equipe de Sucesso do Cliente
Entre em contato conosco!