Saltar al contenido principal

API REST v1: Oportunidades Manejo y búsqueda de oportunidades con la API de DataCrush.

Team DataCrush

[Tiempo de lectura del articulo - 11:45 minutos]

La API REST de DataCrush permite administrar contactos desde cualquier aplicación de terceros, la misma ofrece las siguientes funciones:

Detalles del método
HTTP method:    POST
Respuesta:    JSON
Requiere autorización:    SI
URL:    https://api.datacrush.la/contact/insert


Códigos de error .

Código Descripción
100 Acceso denegado
101 Se superó el límite de llamadas a la API. (100 llamadas por minuto)
200 Error en validación de campos
201 El campo es obligatorio
202 No cumple con el mínimo de caracteres
203 No cumple con el máximo de caracteres
204 El tipo de campo es incorrecto
205 El contenido es inválido, no concuerda con los valores aceptados por el campo
206 El campo o propiedad no existe
207 El valor ya existe
208 El campo o propiedad no puede ser modificado
209 El valor no puede ser vacío
300 Error del sistema, fallo al insertar la oportunidad
301 Error del sistema, fallo al actualizar la oportunidad
302 Error del sistema, fallo al eliminar la oportunidad
303 account_key inválida


 1. Creación de un oportunidades.

Creación de una oportunidad en DataCrush con un HTTP POST a la API de Oportundiades.

La oportunidad será creada inmediatamente en tu base de oportunidades y se le asignará un KEY de identificación que podrá ser utilizado para realizar otras operaciones de la API. 

Parámetros requeridos Descripción
portal_id El Portal ID es un número que identifica tu portal. (*)
api_key El API KEY es una llave que valida tu acceso a la API, es una cadena aleatoria de 50 caracteres. (*)
name Nombre de la oportunidad
close_date Fecha de cierre de la oportunidad (formato de fecha YYYY-MM-DD)
amount Valor del monto de la oportunidad
account_key Llave de la cuenta a la cual pertenece la oportunidad
stage Etapa inicial de la oportunidad

(*) Solicita a soporte tus credenciales de acceso.

Respuesta exitosa:

Si la respuesta es exitosa, se devolverá el opportunity_key asociado a la nueva oportunidad. Este opportunity_key puede ser utilizado para identificar a la oportunidad en futuras consultas a la API.

Ejemplo: 

{"result":"success","opportunity_key":"WhCmx1Bm0IZ4Kf5CAWwl36oJZkNTrPoo6AsFa32kM1oahp9RqG"}

 Respuesta con error:

En caso de existir un error en la creación de la oportunidad, se devolverá un JSON con el código de error y un detalle de propiedades con error

Ejemplo:

{
"result":"fail"
,"error": {"code":200,"message":"Validation error"}
,"error_list":[
	{"label":"name","field":"name","value":"","error":{"code":209,"message":"The value of this field can not be empty"}},
	]
}

 Ejemplo de alta de oportunidad en PHP:

<?php

$url = https://api.datacrush.la/crm/opportunity/insert;

$postData	= array(
	"portal_id" => yourportalID,
	"api_key" => "yourapikey",
	"name" => "Oportunity name"
);

$ch = curl_init();

curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POSTFIELDS, $postData);

$data = json_decode(curl_exec($ch));

$info = curl_getinfo($ch);

if($info['http_code'] != 200) {


} else {

	if( $data->result == "success") {
		$account_key = $data->account_key;
	} else {
		$errors = $data->error_list;
	}

}

curl_close($ch);

?>

 2. Actualización de una oportunidad.

Actualiza cualquier propiedad de una oportunidad existente en tu base de oportunidades de DataCrush con un HTTP POST.

Se debe utilizar el opportunity_key asociado a esa oportunidad para poder actualizarla, en caso de no saberlo se puede realizar primero una búsqueda para obtenerlo

Parámetros requeridos Descripción
portal_id El Portal ID es un número que identifica tu portal. (*)
api_key El API KEY es una llave que valida tu acceso a la API, es una cadena aleatoria de 50 caracteres. (*)
name Nombre de la oportunidad
close_date Fecha de cierre de la oportunidad (formato de fecha YYYY-MM-DD)
amount Valor del monto de la oportunidad
account_key Llave de la cuenta a la cual pertenece la oportunidad

 (*) Solicita a soporte tus credenciales de acceso.

Respuesta exitosa:

Si la respuesta es exitosa, se devolverá success

Ejemplo: 

{"result":"success"}

 Respuesta con error:

En caso de existir un error en la actualización de la oportunidad, se devolverá un JSON con el código de error y un detalle de propiedades con error

Ejemplo:

{
"result":"fail"
,"error": {"code":200,"message":"Validation error"}
,"error_list":[
	{"label":"name","field":"name","value":"","error":{"code":209,"message":"The value of this field can not be empty"}},
	]
}

 Ejemplo de actualización de la oportunidad en PHP:

<?php

$url = https://api.datacrush.la/crm/opportunity/update;

$postData	= array(
	"portal_id" => yourportalID,
	"api_key" => "yourapikey",
	"name" => "New name",
	"apportunity_ley" => "someopportunitykey"
);

$ch = curl_init();

curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POSTFIELDS, $postData);

$data = json_decode(curl_exec($ch));

$info = curl_getinfo($ch);

if($info['http_code'] != 200) {

	echo("error");
  
} else {

	if( $data->result == "success") {
		echo("Ok");
		
	} else {
		$errors = $data->error_list;
	}
	print_r($errors);

}

curl_close($ch);


?>

 3. Eliminación de una oportunidad.

Elimina una oportunidad existente en tu base de oportunidades de DataCrush con un HTTP POST.

Se debe utilizar el opportunity_key asociado a esa oportundiad para poder eliminarla, en caso de no saberlo se puede realizar primero una búsqueda para obtenerlo

‼️ ATENCIÓN: una oportunidad eliminada no podrá ser recuperada.
 
Parámetros requeridos Descripción
portal_id El Portal ID es un número que identifica tu porta. (*)
api_key El API KEY es una llave que valida tu acceso a la API, es una cadena aleatoria de 50 caracteres. (*)
opportunity_key El opportunity_key asociado a la oportunidad que se desea eliminar, para obtenerlo se puede realizar una búsqueda

 (*) Solicita a soporte tus credenciales de acceso.

Respuesta exitosa:

Si la respuesta es exitosa, se devolverá success

Ejemplo: 

{"result":"success"}

Respuesta con error:

En caso de existir un error en la eliminación de la oportunidad, se devolverá un JSON con el código de error.

Ejemplo:

{
"result":"fail"
,"error": {"code":200,"message":"Validation error"}
,"error_list":[]
}

Ejemplo de eliminación de una oportunidad en PHP:

<?php

$url = https://api.datacrush.la/crm/opportunity/delete;

$postData	= array(
	"portal_id" => yourportalID,
	"api_key" => "yourapikey",
	"opportunity_key" => "someopportunitykey"
);

$ch = curl_init();

curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POSTFIELDS, $postData);

$data = json_decode(curl_exec($ch));

$info = curl_getinfo($ch);

if($info['http_code'] != 200) {

	echo("error");
  
} else {

	if( $data->result == "success") {
		echo("Ok");
		
	} else {
		$errors = $data->error_list;
	}
	print_r($errors);

}

curl_close($ch);


?>

 4. Búsqueda de una oportunidades.

Busca una oportunidad existente en tu base de oportunidades de DataCrush con un HTTP POST.

La búsqueda puede realizarse por una o varias propiedades. Estas propiedades deben ser sólo las habilitadas para búsqueda.

‼️ Nota: la búsqueda siempre devolverá un máximo de 100 oportunidades.
 
Parámetros requeridos Descripción
portal_id El Portal ID es un número que identifica tu portal. (*)
api_key El API KEY es una llave que valida tu acceso a la API, es una cadena aleatoria de 50 caracteres. (*)
name Nombre de la oportunidad

 (*) Solicita a soporte tus credenciales de acceso.

Respuesta exitosa:

Si la respuesta es exitosa, se devolverá success y el listado de oportunidades con sus propiedades

Ejemplo: 

{"result":"success","rows":[ list of fields and values]}

Respuesta con error:

En caso de existir un error en la consulta, se devolverá un JSON con el código de error.

Ejemplo:

{
"result":"fail"
,"error": {"code":200,"message":"Validation error"}
,"error_list":[]
}

 Ejemplo de una consulta en PHP:

<?php

$url = https://api.datacrush.la/account/search;


$postData	= array(
	"portal_id" => yourportalID,
	"api_key" => "yourapikey",
	"account_key" => "someopportunitykey"
);

$ch = curl_init();

curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POSTFIELDS, $postData);

$data = json_decode(curl_exec($ch));

$info = curl_getinfo($ch);

if($info['http_code'] != 200) {

	echo("error");
  
} else {

	if( $data->result == "success") {

		print_r($data->rows);
		
	} else {
		$errors = $data->error_list;
	}
	print_r($errors);

}

curl_close($ch);

?>

 5. Agregar un contacto a una oportunidad.

Agrega un contacto existente en una oportunidad de tu base de oportunidades de DataCrush con un HTTP POST.

Se debe utilizar el opportunity_key asociado a esa oportunidad y el contact_key del contacto existente, en caso de no saberlo se puede realizar primero una búsqueda para obtenerlo.

Parámetros requeridos Descripción
portal_id El Portal ID es un número que identifica tu porta. (*)
api_key El API KEY es una llave que valida tu acceso a la API, es una cadena aleatoria de 50 caracteres. (*)
opportunity_key El opportunity_key asociado a la oportunidad, para obtenerlo se puede realizar una búsqueda
contact_key El contact_key asociado al contacto que se desea asociar
role Rol del contacto dentro de la oportunidad
main Si el contacto es principal o no (1=si, 0=no)

 (*) Solicita a soporte tus credenciales de acceso.

Respuesta exitosa:

Si la respuesta es exitosa, se devolverá success

Ejemplo: 

		{"result":"success"}

Respuesta con error:

En caso de existir un error en la ejecución, se devolverá un JSON con el código de error.

Ejemplo: 

		{
		"result":"fail"
		,"error": {"code":200,"message":"Validation error"}
		,"error_list":[]
		}

 Ejemplo de asociar un contacto a una oportunidad en PHP: 

<?php

$url = https://api.datacrush.la/crm/opportunity/contact-add;

$postData	= array(
	"portal_id" => yourportalID,
	"api_key" => "yourapikey",
	"opportunity_key" => "someopportunitykey",
	"contact_key" => "somecontactkey"				
);

$ch = curl_init();

curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POSTFIELDS, $postData);

$data = json_decode(curl_exec($ch));

$info = curl_getinfo($ch);

if($info['http_code'] != 200) {

	echo("error");

} else {

	if( $data->result == "success") {
		echo("Ok");

	} else {
		$errors = $data->error_list;
	}
	print_r($errors);

}

curl_close($ch);


?>

 6. Remover un contacto de una oportunidad.

Remover un contacto asociado a una oportunidad de tu base de oportunidades de DataCrush con un HTTP POST.

Se debe utilizar el opportiunity_ley asociado a esa oportunidad y el contact_key del contacto existente, en caso de no saberlo se puede realizar primero una búsqueda para obtenerlo

Parámetros requeridos Descripción
portal_id El Portal ID es un número que identifica tu porta. (*)
api_key El API KEY es una llave que valida tu acceso a la API, es una cadena aleatoria de 50 caracteres. (*)
opportunity_key El opportunity_key asociado a la oportunidad, para obtenerlo se puede realizar una búsqueda
contact_key El contact_key asociado al contacto que se desea asociar

 (*) Solicita a soporte tus credenciales de acceso.

Respuesta exitosa:

Si la respuesta es exitosa, se devolverá success.

Ejemplo:

	{"result":"success"}

 Respuesta con error:

En caso de existir un error en la ejecución, se devolverá un JSON con el código de error.

Ejemplo:

{
"result":"fail"
,"error": {"code":200,"message":"Validation error"}
,"error_list":[]
}

 Ejemplo de remover un contacto de una oportunidad en PHP:

<?php

$url = https://api.datacrush.la/crm/opportunity/contact-delete;

$postData	= array(
	"portal_id" => yourportalID,
	"api_key" => "yourapikey",
	"opportunity_key" => "someopportunitykey",
	"contact_key" => "somecontactkey"				
);

$ch = curl_init();

curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POSTFIELDS, $postData);

$data = json_decode(curl_exec($ch));

$info = curl_getinfo($ch);

if($info['http_code'] != 200) {

	echo("error");

} else {

	if( $data->result == "success") {
		echo("Ok");

	} else {
		$errors = $data->error_list;
	}
	print_r($errors);

}

curl_close($ch);


?>

 7. Cambiar la etapa de una oportunidad.

Cambia la etapa de una oportunidad de tu base de oportunidades de DataCrush con un HTTP POST.

Se debe utilizar el opportiunity_ley asociado a esa oportunidad, en caso de no saberlo se puede realizar primero una búsqueda para obtenerlo.

 
Parámetros requeridos Descripción
portal_id El Portal ID es un número que identifica tu porta. (*)
api_key El API KEY es una llave que valida tu acceso a la API, es una cadena aleatoria de 50 caracteres. (*)
opportunity_key El opportunity_key asociado a la oportunidad, para obtenerlo se puede realizar una búsqueda
stage Etapa de la oportunidad (valores disponibles: proposal, negotiation, qualification, analysis, closed_lost, closed_won)

(*) Solicita a soporte tus credenciales de acceso.

Respuesta exitosa:

Si la respuesta es exitosa, se devolverá success.

Ejemplo: 

	{"result":"success"}

 Respuesta con error:

En caso de existir un error en la ejecución, se devolverá un JSON con el código de error.

Ejemplo:

{
"result":"fail"
,"error": {"code":200,"message":"Validation error"}
,"error_list":[]
}

 Ejemplo de cambiar la etapa de una oportunidad en PHP: 

<?php

$url = https://api.datacrush.la/crm/opportunity/stage;

$postData	= array(
	"portal_id" => yourportalID,
	"api_key" => "yourapikey",
	"opportunity_key" => "someopportunitykey",
	"stage" => "closed_won"				
);

$ch = curl_init();

curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POSTFIELDS, $postData);

$data = json_decode(curl_exec($ch));

$info = curl_getinfo($ch);

if($info['http_code'] != 200) {

	echo("error");

} else {

	if( $data->result == "success") {
		echo("Ok");

	} else {
		$errors = $data->error_list;
	}
	print_r($errors);

}

curl_close($ch);


?>

Relacionada con

Artículos relacionados

Comentarios

0 comentarios

Inicie sesión para dejar un comentario.