Saltar al contenido principal

Introducción a la API

La API REST de KintiSoft permite conectar aplicaciones externas con la plataforma para consultar información, integrar sistemas y automatizar procesos empresariales.

Esta sección explica los fundamentos necesarios para comunicarte con la API y desarrollar integraciones seguras y mantenibles.

Características principales​

La API de KintiSoft utiliza tecnologías y convenciones habituales de los servicios web.

CaracterísticaDescripción
ArquitecturaREST
ProtocoloHTTPS
Formato de datosJSON
AutenticaciónAPI Key mediante Bearer Token
ContextoArquitectura multi-tenant
OperacionesMétodos HTTP según el recurso
VersionadoVersión de API incluida en la URL

URL base​

KintiSoft utiliza una arquitectura multi-tenant basada en subdominios.

Cada integración debe utilizar la URL correspondiente al tenant autorizado.

La URL base documentada es:

https://{tenant}.api.kintisoft.com/v1

Por ejemplo, para un tenant denominado acme:

https://acme.api.kintisoft.com/v1
información

acme es un identificador de ejemplo. Sustitúyelo por el subdominio correspondiente a tu tenant.

Confirma la URL base de tu entorno antes de desarrollar una integración.

Métodos HTTP​

Las APIs REST utilizan métodos HTTP para representar operaciones sobre recursos.

MétodoPropósito habitual
GETConsultar recursos
POSTCrear recursos o ejecutar operaciones
PUTReemplazar un recurso
PATCHActualizar parcialmente un recurso
DELETEEliminar un recurso
nota

La disponibilidad de cada método depende del endpoint. No todos los recursos admiten todas las operaciones.

Autenticación​

Las solicitudes protegidas requieren una API Key válida.

La documentación actual de KintiSoft establece que la credencial se envía mediante el encabezado Authorization, utilizando el esquema Bearer.

Authorization: Bearer YOUR_API_KEY

Las credenciales permiten identificar la integración y aplicar los permisos correspondientes.

Para conocer el procedimiento completo, consulta Autenticación.

Formato de las solicitudes​

Las operaciones que envían información en formato JSON utilizan habitualmente el encabezado:

Content-Type: application/json

Para indicar que deseas recibir una respuesta JSON:

Accept: application/json

Ejemplo de solicitud​

El siguiente comando muestra la estructura de una solicitud autenticada:

curl --request GET \
  "${KINTISOFT_BASE_URL}/RUTA_DEL_RECURSO" \
  --header "Authorization: Bearer ${KINTISOFT_API_KEY}" \
  --header "Accept: application/json"

En este ejemplo:

  • KINTISOFT_BASE_URL representa la URL base del tenant.
  • KINTISOFT_API_KEY contiene tu credencial.
  • RUTA_DEL_RECURSO debe reemplazarse por una ruta válida de la API.
aviso

Este ejemplo es una plantilla de solicitud. Consulta la API Reference para utilizar una ruta real y verificar los permisos necesarios.

Respuestas HTTP​

La API utiliza códigos de estado HTTP para comunicar el resultado de las operaciones.

Las respuestas pueden indicar:

  • Operación completada correctamente.
  • Error de autenticación.
  • Permisos insuficientes.
  • Datos inválidos.
  • Recurso inexistente.
  • Error temporal del servicio.

Consulta Errores y respuestas para conocer cómo interpretar estos resultados.

Arquitectura multi-tenant​

KintiSoft organiza el acceso a la plataforma mediante tenants.

Cada integración debe utilizar el contexto y las credenciales autorizadas para acceder a sus recursos.

El cliente de la API no debe asumir que puede acceder a información de otros tenants modificando identificadores o rutas.

Para profundizar en este modelo, consulta Arquitectura multi-tenant.

API Reference​

La referencia de API contiene las especificaciones de las operaciones disponibles.

Para cada endpoint podrás consultar, según su documentación:

  • Método HTTP y ruta.
  • Descripción de la operación.
  • Parámetros de entrada.
  • Encabezados requeridos.
  • Estructura de las solicitudes.
  • Esquemas de respuesta.
  • Códigos de estado.
  • Ejemplos de uso.

Buenas prácticas​

Al desarrollar una integración con KintiSoft:

  1. Utiliza siempre HTTPS.
  2. Almacena las API Keys de forma segura.
  3. Solicita únicamente los permisos necesarios.
  4. Valida las respuestas antes de procesarlas.
  5. Gestiona los errores HTTP.
  6. Evita registrar credenciales o datos sensibles.
  7. Comprueba la compatibilidad antes de adoptar cambios de versión.

Continúa explorando​