Chamada de API getMember

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â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_idThe member’s ID in MemberMouse
primeiro_nomeThe member’s first name
sobrenomeThe member’s last name
registradoA data em que o membro se registrou
data_de_cancelamentoThe date the member’s account will be canceled. This will only be set if the member’s account status is cancelamento pendente.
last_logged_inA data em que o membro fez o último login
last_updatedThe date the member’s account was last updated
dias_como_membroO número de dias em que o membro é membro
statusThe 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_statusThe name of status on the member’s account.
is_complimentaryThis 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çãoThe ID of the member’s membership level
nome do nível de associaçãoThe name of the member’s membership level
nome de usuárioThe member’s username
e-mailThe member’s email address
telefoneThe member’s phone number
endereço de cobrançaThe member’s billing address
cidade_de_faturamentoThe member’s billing city
billing_stateThe member’s billing state
billing_zipThe member’s billing zip code
país_de_faturamentoThe member’s billing country
endereço_de_envioThe member’s shipping address
cidade_de_envioThe member’s shipping city
shipping_stateThe member’s shipping state
CEP de remessaThe member’s shipping zip code
país_de_envioThe member’s shipping country
feixesAn array of bundles applied to the member’s account. See table below for parameters available for each bundle.
campos_personalizadosAn 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âmetroDescrição
idThe ID of the bundle applied to the member’s account
nomeThe name of the bundle applied to the member’s account
dias_com_bundleThe number of days the bundle has been applied to the member’s account
statusThe 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_statusThe name of status of the bundle applied to the member’s account.
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_adicionadaThe date the bundle was first applied to the member’s account
last_updatedThe 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âmetroDescrição
idA ID do campo personalizado
nomeO nome do campo personalizado
valorThe value stored in the custom field on the member’s account
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!