A chamada createMember API é usada para criar um membro gratuito ou pago em seu site de associação. Ela também pode ser usada para alterar o nível de associação de um membro existente. Se o endereço de e-mail passado estiver associado a um membro existente e a ID do nível de associação passada for diferente da associada à conta dele, o MemberMouse alterará o nível de associação e cancelará automaticamente todas as assinaturas ativas associadas à associação atual.
IMPORTANTE: Se você optar por passar dados brutos de cartão de crédito usando essa chamada de API, estará exposto a um nível mais alto de requisitos SAQ de conformidade com a PCI (SAQ-D). É sua responsabilidade garantir que esteja em conformidade.
Exemplo de URL de solicitação
http://{Your_API_URL}?q=/createMember
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 |
membership_level_id | ID do nível de associação a ser atribuído à conta do novo membro | Sim |
product_id | Cada nível de associação paga que você criar no MemberMouse terá um produto padrão associado a ele. Se esse campo for deixado em branco, o produto padrão será usado para fazer o pedido. Opcionalmente, você pode passar um ID de produto válido associado ao nível de associação aqui para cobrar um preço diferente do produto padrão para o nível de associação. | Não |
e-mail | Endereço de e-mail do novo membro | Sim |
nome de usuário | Nome de usuário para o novo membro. Se isso não for fornecido, o endereço de e-mail do membro será usado como seu nome de usuário. | Não |
primeiro_nome | Primeiro nome do novo membro | Não |
sobrenome | Sobrenome do novo membro | Não |
senha | A senha que você deseja definir para o novo membro. Se ela não for fornecida, o MemberMouse gerará automaticamente uma senha para o novo membro. | Não |
telefone | Número de telefone do novo membro | Não |
endereço de cobrança | endereço de cobrança do novo membro | Condicional (Não se o nível de associação for gratuito) |
cidade_de_faturamento | cidade de cobrança do novo membro. | Condicional (Não se o nível de associação for gratuito) |
billing_state | estado de cobrança do novo membro | Condicional (Não se o nível de associação for gratuito) |
billing_zip | código postal de cobrança do novo membro | Condicional (Não se o nível de associação for gratuito) |
país_de_faturamento | país de faturamento do novo membro (Código de país ISO de 2 dígitos) | Condicional (Não se o nível de associação for gratuito) |
número_de_crédito | Número do cartão de crédito do novo associado | Condicional (Não se o nível de associação for gratuito) |
exp_month | Mês de vencimento do cartão de crédito do novo associado (2 dígitos) | Condicional (Não se o nível de associação for gratuito) |
ano_exp | Ano de vencimento do cartão de crédito do novo associado (4 dígitos) | Condicional (Não se o nível de associação for gratuito) |
código_de_segurança | Código de segurança (CVV) do cartão de crédito do novo associado | Condicional (Não se o nível de associação for gratuito) |
shipping_same_as_billing | Isso pode ser definido como SIM ou NÃO. Se for definido como YES, você não precisará fornecer informações sobre o endereço de entrega. NO é o valor padrão. | Condicional (Não se o nível de associação for gratuito) |
shipping_method | Código do método de envio do método de envio que você deseja aplicar ao pedido. Você pode encontrar códigos de métodos de envio na tela de métodos de envio no MemberMouse. | Condicional (Não se o nível de associação for gratuito ou se o endereço de entrega for o mesmo que o endereço de cobrança) |
endereço_de_envio | endereço de entrega do novo membro | Condicional (Não se o nível de associação for gratuito ou se o endereço de entrega for o mesmo que o endereço de cobrança) |
cidade_de_envio | cidade de embarque do novo membro | Condicional (Não se o nível de associação for gratuito ou se o endereço de entrega for o mesmo que o endereço de cobrança) |
shipping_state | estado de envio do novo membro | Condicional (Não se o nível de associação for gratuito ou se o endereço de entrega for o mesmo que o endereço de cobrança) |
CEP de remessa | CEP de envio do novo membro | Condicional (Não se o nível de associação for gratuito ou se o endereço de entrega for o mesmo que o endereço de cobrança) |
país_de_envio | país de expedição do novo membro (Código de país ISO de 2 dígitos) | Condicional (Não se o nível de associação for gratuito ou se o endereço de entrega for o mesmo que o endereço de cobrança) |
affiliate_id | ID de afiliado a ser criado com o pedido | Não |
sub_affiliate_id | ID da sub-afiliada para creditar no pedido | Não |
código do cupom | Código de cupom válido que você deseja aplicar ao pedido | Não |
campo_personalizado_[ID#] | Você pode passar dados de campo personalizado para a API passando um ou mais parâmetros no formulário custom_field_[ID#], em que [ID#] seria substituído pela ID do campo personalizado, conforme definido no MemberMouse. Por exemplo, se o ID do campo personalizado for 4, você passaria os dados desse campo personalizado incluindo o parâmetro custom_field_4. | Não |
Códigos de resposta
- 200 - Sucesso
- 409 - Não foi possível criar um novo membro
Dados de resposta
Parâmetro | Descrição |
member_id | A ID do novo membro no MemberMouse |
e-mail | O e-mail do novo membro |
nome de usuário | O nome de usuário do novo membro |
senha | A senha do novo membro |
confirmationUrl | O URL da página de confirmação associada à compra. Ele tem uma chave de transação anexada a ele para que o MemberMouse SmartTags™ funcione nessa página de confirmação. |