Agregar un cliente

Así como podés agregar un cliente de forma manual a través del Panel de Control de Persat, podés hacerlo a través del API. Lo que se requiere es hacer una consulta HTTP POST con los parámetros indicados.

POST https://api.persat.com.ar/v1/clients

Headers

Name	Type	Description
Content-Type	string	application/json
Authorization	string	Bearer API_KEY

Request Body

Name	Type	Description
uid_client*	string	El número/identificador de cliente (es un valor alfanumérico). Debe ser un valor único y sirve para luego poder accederlo en otros llamados a la API
company_name*	string	Nombre del cliente, razón social o nombre de fantasía. También debe ser un valor único. No puede haber dos clientes con la misma "Razon Social"
company_description	string	Descripción del cliente.
latitude	number	Ubicación del cliente, latitud. Valor por default: 0
longitude	number	Ubicación del cliente, longitud. Valor por default: 0
street	string	Calle en donde se encuentra el cliente. No incluir el número
street_nbr	string	Número de la calle. Si bien es numeración, debe ser enviado como string
neighborhood	string	Barrio, por ej: "Devoto"
city	string	Ciudad, por ejemplo "CABA"
country	string	País, por ejemplo: "Argentina"
custom_fields	object	Campos personalizados de la ficha de clientes. Se detalla más adelante en este artículo.
type_id	Number	Identificador del tipo de cliente. En caso de no enviarse el cliente se creara con el type_id = 0, que es el valor por defecto
group_id	Number	Identificador del grupo de cliente. En caso de no enviarse el cliente se creara con el group_id = 0, que es el valor por defecto

200 El cliente fue creado

{
    "success": true,
    "data": {	
        "uid_client": "CL-0044"
        "company_name": "Persat",
        "company_description": "",
        "latitude": -34.60820392067226,
        "longitude": -58.48194122314454,
        "street": "Terrada",
        "street_nbr": "2309",
        "neighborhood": "Comuna 11",
        "city": "Buenos Aires",
        "country": "Argentina",
        "custom_fields": {
            "1": {
                "name": "Nombre",
                "value": ""
            },
            "2": {
                "name": "Teléfono",
                "value": "4504-5300"
            },
            "3": {
                "name": "Email",
                "value": ""
            },
            "4": {
                "name": "Campo 1",
                "value": ""
            },
            "5": {
                "name": "Campo 2",
                "value": ""
            },
            "6": {
                "name": "Campo n",
                "value": ""
            }
        }
    }
}

400 Si por ejemplo el valor de latitude es inválido

{
    "success": false,
    "error": {
        "status": 400,
        "type": "BAD_REQUEST",
        "userMessage": "'latitude' debe ser un número entre -90 y +90"
    }
}

409 Si el número de cliente ingresado uid_client ya existe.

{
    "success": false,
    "error": {
        "status": 409,
        "type": "CONFLICT",
        "userMessage": "Usted ya posee un cliente con este número de cliente"
    }
}

409: Conflict type_id o group_id invalidos. Tal vez en algun momento existian dentro de Persat pero el usuario administrador los elimino.

{
    "success": false,
    "error": {
        "status": 409,
        "type": "CONFLICT",
        "userMessage": "type_id o group_id tiene un valor invalido. Enviar los campos en 0, o no enviar dichos campos"
    }
}

A continuación un ejemplo con curl

curl --location --request POST "https://api.persat.com.ar/v1/clients" \
  --header "Content-Type: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --data "{
	\"uid_client\":\"CL-0044\",  
	\"company_name\":\"Persat\",
	\"company_description\":\"Logistica GPS\",
	\"type_id\": 3,
	\"group_id\": 2,
	\"latitude\":-34.54646,
	\"longitude\":-58.4324324,
	\"street\":\"Av. Rivadavia\",
	\"street_nbr\":232,
	\"neighborhood\":\"Devoto\",
	\"city\":\"CABA\",
	\"country\":\"Argentina\",
	\"custom_fields\": {
        \"2\": \"4504-5300\"
	}
  }"

Los campos son explicados en la sección Obtener un cliente

Algunas aclaraciones respecto a este request.

Si bien latitude y longitude no son campos obligatorios, en Persat todos los clientes se tienen que poder representar en un mapa. Por lo cual, en caso de no enviar estos dos atributos, ambos terminan quedando en 0, dando como resultado un cliente creado en el oceano.

IMPORTANTE: En ningún caso la dirección se calcula automáticamente en base a latitude y longitude.Esto si ocurre desde la aplicación web de Persat, o desde la app de Android. La misma aclaración vale para el caso inverso, es decir que no se calcula la latitud y longitud en base a los datos de dirección enviados.

Es responsabilidad del programador, hacer el geocoding correspondiente para poder brindar los datos de posición