Contactos Proyectos Ventas
Proyectos
Los proyectos de Vendomia sirven para clasificar y organizar todo tu trabajo, agrupando las tareas a realizar en cada una de tus obras y proyectos de empresa.
Uso general

El proceso de autenticación funciona mediante un token de acceso, que se corresponde con unos de los usuarios de tu cuenta.

El nivel de acceso del que dispones con la API dependerá del usuario con el que accedas a ella. Los permisos otorgados según el grupo del usuario a través de la aplicación serán los mismos durante el uso de la API.

Para autenticarse con la API, es necesario enviar el token a través de una cabecera Authorization en cada una de tus solicitudes:

Authorization: Bearer <API_KEY>

Solicitud de ejemplo (PHP)
$data = array(
    "key" => "value",
);

$headers = array(
    "Authorization: Bearer <API_KEY>",
    "Content-Type: application/json",
);

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, "<API_URL>");
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "GET/POST/PUT/DELETE");
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($data));
$response = curl_exec($curl);
curl_close($curl);
GET Listado de Proyectos
Devuelve un listado de elementos.
project_number
number
Número
Número asignado al proyecto
project_name
text
Nombre
Nombre del proyecto
project_description
text
Descripción
Descripción general del proyecto.
project_contact
number
Contacto
ID del contacto asignado al proyecto.
project_type
text
Tipo
Tipo del proyecto
project_status
select
Estado
Estado del proyecto
0
Activo
1
Terminado
2
En Pausa
3
Cancelado
4
Permanente
project_date
date
Fecha
Fecha de plazo del proyecto, en formato YYYY-MM-DD.
project_date_start
date
Fecha de inicio
Fecha de inicio del proyecto, en formato YYYY-MM-DD.
project_date_close
date
Fecha de cierre
Fecha de cierre del proyecto, en formato YYYY-MM-DD.
GET https://vendomia.app/api/projects
Payload de ejemplo
{
    "project_number": "123",
    "project_name": "Proyecto de ejemplo",
    "project_description": "Proyecto de ejemplo",
    "project_contact": "12345",
    "project_type": "123",
    "project_status": "123",
    "project_date": "2020-03-30",
    "project_date_start": "2020-03-30",
    "project_date_close": "2020-03-30",
}
Respuesta de ejemplo
{
    "status": 200,
    "message": "OK.",
    "body": {
        "objects": {
            "12345": {
                "project_number": "123",
                "project_name": "Proyecto de ejemplo",
                "project_description": "Proyecto de ejemplo",
                "project_contact": "12345",
                "project_type": "123",
                "project_status": "123",
                "project_date": "2020-03-30",
                "project_date_start": "2020-03-30",
                "project_date_close": "2020-03-30",
            }
        }
    }
}
GET Recuperar Proyecto
Devuelve un único elemento a través de su identificador primario.
GET https://vendomia.app/api/projects/{id}
Respuesta de ejemplo
{
    "status": 200,
    "message": "OK.",
    "body": {
        "object": {
            "project_number": "123",
            "project_name": "Proyecto de ejemplo",
            "project_description": "Proyecto de ejemplo",
            "project_contact": "12345",
            "project_type": "123",
            "project_status": "123",
            "project_date": "2020-03-30",
            "project_date_start": "2020-03-30",
            "project_date_close": "2020-03-30",
        }
    }
}
POST Crear Proyecto
Crea un nuevo elemento.
project_identity
string
string
project_parent
string
string
project_name
text
Nombre
Nombre del proyecto
project_description
text
Descripción
Descripción general del proyecto.
project_deal
string
string
project_contact
number
Contacto
ID del contacto asignado al proyecto.
project_type
text
Tipo
Tipo del proyecto
project_priority
select
Prioridad
Nivel de prioridad asociada al proyecto.
0
0 - Baja
1
1 - Media
2
2 - Alta
3
3 - Urgente
project_price
number
Valor
Valor monetario del proyecto.
project_to_deal
number
ID de Venta
project_to_estimate
number
ID de Presupuesto
project_date
date
Fecha
Fecha de plazo del proyecto, en formato YYYY-MM-DD.
project_date_start
date
Fecha de inicio
Fecha de inicio del proyecto, en formato YYYY-MM-DD.
project_date_close
date
Fecha de cierre
Fecha de cierre del proyecto, en formato YYYY-MM-DD.
POST https://vendomia.app/api/projects
Payload de ejemplo
{
    "project_name": "Proyecto de ejemplo",
    "project_description": "Proyecto de ejemplo",
    "project_contact": "12345",
    "project_type": "123",
    "project_date": "2020-03-30",
    "project_date_start": "2020-03-30",
    "project_date_close": "2020-03-30",
}
Respuesta de ejemplo
{
    "status": 200,
    "message": "OK.",
    "body": {
        "object": {
            "project_number": "123",
            "project_name": "Proyecto de ejemplo",
            "project_description": "Proyecto de ejemplo",
            "project_contact": "12345",
            "project_type": "123",
            "project_status": "123",
            "project_date": "2020-03-30",
            "project_date_start": "2020-03-30",
            "project_date_close": "2020-03-30",
        }
    }
}
PUT Modificar Proyecto
Modifica un elemento existente según su identificador primario.
project_identity
string
string
project_parent
string
string
project_name
text
Nombre
Nombre del proyecto
project_description
text
Descripción
Descripción general del proyecto.
project_deal
string
string
project_contact
number
Contacto
ID del contacto asignado al proyecto.
project_type
text
Tipo
Tipo del proyecto
project_priority
select
Prioridad
Nivel de prioridad asociada al proyecto.
0
0 - Baja
1
1 - Media
2
2 - Alta
3
3 - Urgente
project_price
number
Valor
Valor monetario del proyecto.
project_to_deal
number
ID de Venta
project_to_estimate
number
ID de Presupuesto
project_date
date
Fecha
Fecha de plazo del proyecto, en formato YYYY-MM-DD.
project_date_start
date
Fecha de inicio
Fecha de inicio del proyecto, en formato YYYY-MM-DD.
project_date_close
date
Fecha de cierre
Fecha de cierre del proyecto, en formato YYYY-MM-DD.
PUT https://vendomia.app/api/projects/{id}
Payload de ejemplo
{
    "project_name": "Proyecto de ejemplo",
    "project_description": "Proyecto de ejemplo",
    "project_contact": "12345",
    "project_type": "123",
    "project_date": "2020-03-30",
    "project_date_start": "2020-03-30",
    "project_date_close": "2020-03-30",
}
Respuesta de ejemplo
{
    "status": 200,
    "message": "OK.",
    "body": {
        "object": {
            "project_number": "123",
            "project_name": "Proyecto de ejemplo",
            "project_description": "Proyecto de ejemplo",
            "project_contact": "12345",
            "project_type": "123",
            "project_status": "123",
            "project_date": "2020-03-30",
            "project_date_start": "2020-03-30",
            "project_date_close": "2020-03-30",
        }
    }
}
DELETE Borrar Proyecto
Borra un elemento existente.
DELETE https://vendomia.app/api/projects/{id}
Respuesta de ejemplo
{
    "status": 200,
    "message": "OK.",
    "body": {}
}
POST Cambiar un proyecto de fase
(Sin descripción)
project_stage
remoteselect
Fase
Fase actual del proyecto
POST https://vendomia.app/api/projects/{id}/stage_project
Respuesta de ejemplo
{
    "status": 200,
    "message": "OK.",
    "body": {}
}
POST Finalizar un proyecto
Marca un proyecto como finalizado.
POST https://vendomia.app/api/projects/{id}/finish_project
Respuesta de ejemplo
{
    "status": 200,
    "message": "OK.",
    "body": {}
}
POST Pausar un proyecto
Marca un proyecto como pausado.
POST https://vendomia.app/api/projects/{id}/pause_project
Respuesta de ejemplo
{
    "status": 200,
    "message": "OK.",
    "body": {}
}
POST Reanudar un proyecto
Marca un proyecto como activo.
POST https://vendomia.app/api/projects/{id}/resume_project
Respuesta de ejemplo
{
    "status": 200,
    "message": "OK.",
    "body": {}
}
POST Hacer permanente un proyecto
Marca un proyecto como permanente.
POST https://vendomia.app/api/projects/{id}/permanent_project
Respuesta de ejemplo
{
    "status": 200,
    "message": "OK.",
    "body": {}
}
POST Cancelar un proyecto
Marca un proyecto como cancelado.
POST https://vendomia.app/api/projects/{id}/cancel_project
Respuesta de ejemplo
{
    "status": 200,
    "message": "OK.",
    "body": {}
}