The getMember API call is used to retrieve information about an existing member’s account.
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 | The member’s ID in MemberMouse |
primeiro_nome | The member’s first name |
sobrenome | The member’s last name |
registrado | A data em que o membro se registrou |
data_de_cancelamento | The date the member’s account will be canceled. This will only be set if the member’s account status is cancelamento pendente. |
last_logged_in | A data em que o membro fez o último login |
last_updated | The date the member’s account was last updated |
dias_como_membro | O número de dias em que o membro é membro |
status | The status of the member’s account. 1 (Active), 2 (Canceled), 3 (Locked), 4 (Paused), 5 (Overdue), 6 (Pending Activation), 7 (Error), 8 (Expired), 9 (Pending Cancellation) |
nome_do_status | The name of status on the member’s account. |
is_complimentary | This indicates if the member’s account is complimentary or not. It will be set to true if the account is complimentary and false if not. |
nível de associação | The ID of the member’s membership level |
nome do nível de associação | The name of the member’s membership level |
nome de usuário | The member’s username |
e-mail | The member’s email address |
telefone | The member’s phone number |
endereço de cobrança | The member’s billing address |
cidade_de_faturamento | The member’s billing city |
billing_state | The member’s billing state |
billing_zip | The member’s billing zip code |
país_de_faturamento | The member’s billing country |
endereço_de_envio | The member’s shipping address |
cidade_de_envio | The member’s shipping city |
shipping_state | The member’s shipping state |
CEP de remessa | The member’s shipping zip code |
país_de_envio | The member’s shipping country |
feixes | An array of bundles applied to the member’s account. See table below for parameters available for each bundle. |
campos_personalizados | An array of custom fields associated with the member’s account. See the table below for parameters available for each custom field. |
Dados do pacote
Bundle data is stored as an array of items in the bundles attribute as part of the response data. Data will only be returned for bundles that are active on the member’s account. The table below outlines the parameters returned for each item in the bundles array.
| Parâmetro | Descrição |
id | The ID of the bundle applied to the member’s account |
nome | The name of the bundle applied to the member’s account |
dias_com_bundle | The number of days the bundle has been applied to the member’s account |
status | The numeric status of the bundle applied to the member’s account. The value may be any of the following: 1 (Ativo), 4 (Em pausa), 9 (Cancelamento pendente) |
nome_do_status | The name of status of the bundle applied to the member’s account. |
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 | The date the bundle was first applied to the member’s account |
last_updated | The date the bundle was last updated on the member’s account |
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 | The value stored in the custom field on the member’s account |

