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âmetro | Descrição | Necessário |
apikey | Chave de API de Credenciais da API do MemberMouse | Sim |
apisecret | Segredo da API de Credenciais da API do MemberMouse | Sim |
member_id | ID do membro a ser recuperado | Sim, se o endereço de e-mail não for fornecido |
e-mail | Endereço de e-mail do membro a ser recuperado | Sim, 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âmetro | Descrição |
member_id | O ID do membro no MemberMouse |
primeiro_nome | O primeiro nome do membro |
sobrenome | O sobrenome do membro |
registrado | A data em que o membro se registrou |
data_de_cancelamento | A 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_in | A data em que o membro fez o último login |
last_updated | A data em que a conta do membro foi atualizada pela última vez |
dias_como_membro | O número de dias em que o membro é membro |
status | O 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_status | O nome do status na conta do membro. |
is_complimentary | Indica 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ção | A ID do nível de associação do membro |
nome do nível de associação | O nome do nível de associação do membro |
nome de usuário | O nome de usuário do membro |
e-mail | O endereço de e-mail do membro |
telefone | O número de telefone do membro |
endereço de cobrança | O endereço de cobrança do associado |
cidade_de_faturamento | A cidade de cobrança do associado |
billing_state | O estado de faturamento do associado |
billing_zip | O código postal de cobrança do associado |
país_de_faturamento | O país de cobrança do membro |
endereço_de_envio | O endereço de entrega do membro |
cidade_de_envio | A cidade de embarque do membro |
shipping_state | O estado de envio do membro |
CEP de remessa | Código postal de envio do membro |
país_de_envio | O país de envio do membro |
feixes | Uma matriz de pacotes aplicados à conta do membro. Consulte a tabela abaixo para obter os parâmetros disponíveis para cada pacote. |
campos_personalizados | Uma 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âmetro | Descrição |
id | O ID do pacote aplicado à conta do membro |
nome | O nome do pacote aplicado à conta do membro |
dias_com_bundle | O número de dias em que o pacote foi aplicado à conta do associado |
status | O 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_status | O nome do status do pacote aplicado à conta do membro. |
is_complimentary | Indica se o pacote é gratuito ou não. Será definido como true se o pacote for complementar e false se não for. |
data_adicionada | A data em que o pacote foi aplicado pela primeira vez à conta do associado |
last_updated | A 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âmetro | Descrição |
id | A ID do campo personalizado |
nome | O nome do campo personalizado |
valor | O valor armazenado no campo personalizado na conta do membro |