Primeros pasos con la API MemberMouse

URL y credenciales de la API

Lo primero que necesita para utilizar la API de MemberMouse es la URL de la API y las credenciales. En la MemberMouse menú ir a Herramientas para desarrolladores y haga clic en el botón Ficha Credenciales API. En esta página, puede ver su URL API y crear y gestionar credenciales API.

Ejecución de una llamada a la API

Para realizar una llamada a la API, deberá realizar una solicitud a la URL de llamada a la API y pasar los parámetros de entrada correspondientes. La URL de llamada a la API y los parámetros de entrada variarán en función de la llamada a la API que se realice. Consulte este artículo sobre una lista de las llamadas a la API en MemberMouse y haga clic en una llamada a la API para ver la URL asociada y los parámetros de entrada.

Descargar código de ejemplo para PHP

A continuación se muestra un ejemplo de llamada a la API para crear un nuevo miembro utilizando la función Llamada a la API createMember.

En primer lugar, configuramos los parámetros de entrada como una cadena de pares nombre/valor separados por un signo & y se almacena en el $inputParams variable.

A continuación, establecemos la URL de la llamada a la API e inicializamos un archivo Instancia cURL.

Por último, ejecutamos la instancia cURL, decodificamos el resultado de la llamada y lo almacenamos en un archivo $data y luego mostrarlo en la pantalla.

$inputParams = "apikey={Su_Clave_API}&apisecret={Su_Secreto_API}&";
$inputParams .= "first_name=Tom&";
$inputParams .= "last_name=Smith&";
$inputParams .= "[email protected]&";
$inputParams .= "phone=(212) 555-7864&";
$inputParams .= "membership_level_id=2&";

$apiCallUrl = "https://{Your_API_URL}?q=/createMember";
$ch = curl_init($apiCallUrl);

curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $inputParams);
curl_setopt($ch, CURLOPT_HEADER, 0);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$result = curl_exec($ch);
curl_close($ch);

echo "Respuesta RAW: ".$result".<br />";
$data = json_decode($result);
echo "<pre>";
var_dump($data-&gt;response_data);
echo "</pre>"; 

Para modificar esto para diferentes llamadas a la API tendrá que cambiar la URL de la llamada a la API y los parámetros de entrada de acuerdo con la documentación de la llamada a la API que está haciendo.

mod_security Bloqueo de peticiones

En algunos servidores es posible que las llamadas a la API sean rechazadas por el servidor. Esto suele estar relacionado con la configuración de seguridad del servidor, como mod_security. Para evitar esto, puede intentar pasar cabeceras adicionales a la solicitud cURL para simular que proviene de un navegador real de la siguiente manera:

1TP4Cabeceras = array(
'Referrer: http://yourdomain.com',
'User-Agent: Mozilla/5.0 (X11; Ubuntu; Linux i686; rv:28.0) Gecko/20100101 Firefox/28.0'
);
curl_setopt($ch,CURLOPT_HTTPHEADER,$headers); 

Por supuesto, deberá sustituir http://yourdomain.com por su dominio real.

Acceso al código de respuesta

En el ejemplo de solicitud anterior json_decode() se utiliza para analizar el objeto resultante de la llamada a la API y almacenarlo en el archivo $data variable. En este punto, se puede acceder al código de respuesta de la siguiente manera:

$data->código_respuesta;

Consulte este artículo para una lista de las llamadas a la API en MemberMouse y haga clic en una llamada a la API para ver los códigos de respuesta asociados.

Acceso a los datos de respuesta

En el ejemplo de solicitud anterior json_decode() se utiliza para analizar el objeto resultante de la llamada a la API y almacenarlo en el archivo $data variable. En este punto, se puede acceder a los datos de respuesta de la siguiente manera:

$data->response_data->nombre_usuario;
$data->response_data->contraseña;
$data->response_data->email;

Dónde nombre de usuario, contraseña y correo electrónico son parámetros válidos en el objeto de datos de respuesta. La lista de parámetros válidos variará en función de la llamada a la API realizada. Consulte este artículo para una lista de las llamadas a la API en MemberMouse y haga clic en una llamada a la API para ver los datos de respuesta asociados.

Descargar código de ejemplo para Python