Empezando

Esta guía te ayudará a navegar y aprovechar al máximo nuestros recursos técnicos. Para comenzar, te recomendamos revisar esta visión general de la estructura de la documentación, las herramientas disponibles, los requisitos previos y la información clave para facilitar la comprensión y el uso de la API de Kamin Ledger.

Nuestra documentación sigue el marco Diátaxis, un enfoque moderno para la escritura técnica que organiza la información en cuatro tipos clave:

  • Tutoriales: Guías paso a paso que te ayudan a aprender haciendo. Perfectas para cualquier persona que quiera comenzar rápidamente.
  • Guías prácticas: Recetas útiles para resolver problemas específicos. Ideales para usuarios con una tarea concreta que necesitan una guía enfocada.
  • Referencias: Descripciones completas y precisas de componentes del sistema, APIs y comandos. Es tu recurso principal para detalles técnicos.
  • Explicaciones: Discusiones y descripciones conceptuales que te ayudan a entender el “por qué” detrás del diseño y funcionalidad del sistema.

Familiarizándote con el sistema

Recomendamos comenzar explorando la sección de Conceptos clave y Interacción con Studio, que presenta las entidades principales utilizadas en el sistema. Este entendimiento fundamental hará que tu aprendizaje sea más fluido y efectivo.

CLI

Antes de comenzar con la implementación, revisa nuestra herramienta de línea de comandos (CLI), que agiliza la interacción con el Kamin Ledger. Esta herramienta te permite conectarte e interactuar con el sistema sin necesidad de escribir código. Consulta la Referencia CLI para obtener detalles sobre su uso y comandos.

API y SDK

Una vez que estés familiarizado con el sistema, explora la Referencia de API para comenzar tu proceso de integración y la sección de Esquemas para ver las reglas y restricciones de, por ejemplo, un intent. Si estás utilizando Node.js, consulta el SDK Cheat Sheet. Este proporciona herramientas y métodos que simplifican el proceso de conexión y aceleran el desarrollo.

Guías y tutoriales

Asegúrate de revisar las Guías prácticas y los Tutoriales, que cubren los pasos más comunes para completar una integración completa.

Para comenzar a usar el sistema, necesitarás una invitación para unirte a Kamin. Esta invitación te dará acceso a tu dominio. Recibirás las URLs de staging y producción para la integración. Estas te serán compartidas antes de comenzar la integración y después de completar la certificación, respectivamente.