[Tiempo de lectura del articulo: 10:32 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 cuenta |
| 301 | Error del sistema, fallo al actualizar la cuenta |
| 302 | Error del sistema, fallo al eliminar la cuenta |
| 303 | account_key inválida |
1. Creación de un cuentas.
Creación de una cuenta en DataCrush con un HTTP POST a la API de Cuentas.
La cuenta será creada inmediatamente en tu base de cuentas y se le asignará un KEY de identificación que podrá ser utilizado para buscar la cuenta utilizando esta misma 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 cuenta |
(*) Solicita a soporte tus credenciales de acceso.
| Parámetros opcionales | Descripción |
|---|---|
| {Nombre de propiedad} | Cualquier propiedad existente en DataCrush, debe utilizarse el nombre de la etiqueta |
Respuesta exitosa:
Si la respuesta es exitosa, se devolverá el account_key asociado a la nueva cuenta.
Este account_key puede ser utilizado para identificar a la cuenta en futuras consultas a la API.
Ejemplo:
{"result":"success","account_key":"WhCmx1Bm0IZ4Kf5CAWwl36oJZkNTrPoo6AsFa32kM1oahp9RqG"}
Respuesta con error:
En caso de existir un error en la creación de la cuenta, 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"}},
{"label":"phone","field":"phone","value":"a","error":{"code":204,"message":"The type of field is not correct"}},
]
}
Ejemplo de alta de cuenta en PHP:
<?php
$url = https://api.datacrush.la/account/insert;
$postData = array(
"portal_id" => yourportalID,
"api_key" => "yourapikey",
"name" => "Account 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 cuenta.
Actualiza cualquier propiedad de una cuenta existente en tu base de cuentas de DataCrush con un HTTP POST.
Se debe utilizar el account_key asociado a esa cuenta 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. (*) |
| account_key | El account_key asociado a ala cuenta que se desea actualizar, para obtenerlo se puede realizar una búsqueda |
(*) Solicita a soporte tus credenciales de acceso.
| Parámetros opcionales | Descripción |
|---|---|
| {Nombre de propiedad} | Cualquier propiedad existente en DataCrush, debe utilizarse el nombre de la etiqueta. |
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 cuenta, 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"}},
{"label":"phone","field":"phone","value":"a","error":{"code":204,"message":"The type of field is not correct"}},
]
}
Ejemplo de actualización de la cuenta en PHP:
<?php
$url = https://api.datacrush.la/account/update;
$postData = array(
"portal_id" => yourportalID,
"api_key" => "yourapikey",
"name" => "New name",
"account_key" => "someaccountkey"
);
$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 cuenta.
Elimina una cuenta existente en tu base de cuentas de DataCrush con un HTTP POST.
Se debe utilizar el account_key asociado a esa cuenta para poder eliminarla, 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. (*) |
| account_key | El account_key asociado a la cuenta 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 cuenta, 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 cuenta en PHP:
<?php
$url = https://api.datacrush.la/account/delete;
$postData = array(
"portal_id" => yourportalID,
"api_key" => "yourapikey",
"account_key" => "someaccountkey"
);
$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 cuenta.
Busca una cuenta existente en tu base de cuentas 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
| 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. (*) |
| {Nombre de propiedad} | Es obligatorio pasar una propiedad existente habilitada para búsqueda para realizar la búsqueda, debe utilizarse el nombre de la etiqueta |
(*) Solicita a soporte tus credenciales de acceso.
| Parámetros opcionales | Descripción |
|---|---|
| {Nombre de propiedad} | Cualquier propiedad existente en DataCrush habilitada para búsqueda, debe utilizarse el nombre de la etiqueta |
Respuesta exitosa:
Si la respuesta es exitosa, se devolverá success y el listado de cuentas 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":[]
}
Propiedades habilitadas para búsqueda.
- name
- domain
- lifecycle
- website
- photo
- number_employees
- annual_revenue
- industry
- country
- phone
- about_us
- description
- revenue
- street
- city
- state
- postal_code
- created_date
- modified_date
Ejemplo de una consulta en PHP:
<?php
$url = https://apo.datacrush.la/account/search;
$postData = array(
"portal_id" => yourportalID,
"api_key" => "yourapikey",
"account_key" => "someaccountkey"
);
$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 cuenta.
Agrega un contacto existente en una cuenta de tu base de cuentas de DataCrush con un HTTP POST.
Se debe utilizar el account_key asociado a esa cuenta 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. (*) |
| account_key | El account_key asociado a la cuenta, 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 asociar un contacto a una cuenta en PHP:
<?php
$url = https://api.datacrush.la/account/contact-add;
$postData = array(
"portal_id" => yourportalID,
"api_key" => "yourapikey",
"account_key" => "someaccountkey",
"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 cuenta.
Remover un contacto asociado a una cuenta de tu base de cuentas de DataCrush con un HTTP POST.
Se debe utilizar el account_key asociado a esa cuenta 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. (*) |
| account_key | El account_key asociado a la cuenta, 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 cuenta en PHP:
<?php
$url = https://api.datacrush.la/account/contact-delete;
$postData = array(
"portal_id" => yourportalID,
"api_key" => "yourapikey",
"account_key" => "someaccountkey",
"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);
?>
Relacionada con
Comentarios
0 comentarios
Inicie sesión para dejar un comentario.