Skip to main content

🚀 Primeros pasos con la API

Antes de comenzar a consumir los servicios web, es importante entender cómo está estructurado el entorno y por dónde empezar. Esta guía te ayudará a realizar tus primeras pruebas con la API utilizando los servicios más simples: los relacionados con personas.

🌍 Entornos disponibles​

La plataforma dispone de dos entornos:

  1. Entorno de producción

    • Contiene los datos reales de trabajo.
    • Solo debe utilizarse cuando se tenga certeza de que la integración es estable y segura.

  2. Entorno de pruebas (sandbox)

    • Usado para desarrollar e integrar sin riesgos.
    • Incluye una copia de los datos del entorno de producción, actualizada semanalmente.
    • Se recomienda realizar todas las pruebas iniciales en este entorno.

Las credenciales de prueba te serán proporcionadas por el equipo técnico.
Asegúrate de usar siempre la URL correspondiente al entorno de pruebas.

🔐 Paso 1: Obtener el token de autenticación​

Para poder consumir los servicios, primero debes obtener un token que se usará en las siguientes peticiones.

  • Realizar una solicitud a nuestro servidor de autenticación.
  • El servidor generará y devolverá el valor de autenticación basado en los parámetros proporcionados.
  • El token tiene una duración de una semana antes de caducar.

💡 Guarda este access_token y úsalo en todas tus peticiones en el header.

👤 Paso 2: Consultar los datos de una persona​

Una vez obtenido el token, es buena práctica hacer una primera consulta sencilla. Vamos a recuperar los datos de una persona para verificar que la autenticación funciona correctamente.

Endpoint: Obtener persona

✅ Si esta llamada funciona correctamente, significa que ya estás autenticado y puedes empezar a probar otros servicios.

📝 Paso 3: Crear una persona de prueba​

Vamos a insertar una nueva persona en el sistema, lo cual te permitirá probar cómo se estructuran las peticiones POST.

Endpoint: Insertar persona

Guarda el idPerson ya que lo puedes usar en llamadas posteriores para actualizar o consultar a esta persona.

🔄 Paso 4: Modificar una persona existente​

Probamos ahora un PUT para actualizar los datos de la persona que acabamos de crear.

Endpoint: Actualizar persona

❌ Paso 5: Eliminar una persona de prueba​

Puedes finalizar la prueba eliminando la persona creada.

Endpoint: Eliminar persona

✅ Resultado final​

Después de seguir esta guía, habrás aprendido:

  • Cómo autenticarse en el entorno de pruebas.
  • Cómo usar el token para acceder a los servicios.
  • Cómo realizar operaciones básicas con el recurso "persona": leer, crear, actualizar y eliminar.

Recomendamos familiarizarse con este flujo antes de pasar a servicios más complejos como fincas, unidades de cultivo o planes de abonado.