¿Cómo comenzar?
Cree su propia solución de compensación de CO2
No importa si decide integrarse con nuestra API o usar nuestro Whitelabel, la sección de cómo comenzar tiene como objetivo brindarle una descripción general y un conocimiento de cómo funciona una integración con ClimateTrade y cómo configurarla rápidamente para comenzar a ofrecer su propia solución climática.
Modelos de integración
En este momento, ofrecemos un único modelo de integración (próximamente más) llamado Saldo o Balance de CO2, en el que compra una cantidad de créditos de carbono del proyecto que prefiera (el saldo), y luego puede usar la API o el Whitelabel para compensar y consumir esos créditos. En este modelo, obtendrá un certificado oficial del proyecto del que compró el CO2 y luego por cada compensación realizada a través de la API/Whitelabel obtendrá nuestro certificado de blockchain que enlaza con el certificado oficial del registro.
Este modelo le permite ofrecer compensación de carbono con una granularidad de Kg a sus clientes (en las compras directas del proyecto, la cantidad mínima es de toneladas) y, por lo general, beneficiarse de mejores precios para volúmenes más altos, manteniendo la trazabilidad y la transparencia en todo el proceso de adquisición de créditos de carbono y compensación.
Configuración de cuenta
Todo el proceso comienza con la creación de una cuenta, que se puede realizar en 3 sencillos pasos.
- Crear usuario
- Crear integración
- Adquiere tCO2 para tu saldo
Para crear un usuario simplemente regístrese en climatetrade.com (es gratis) y seleccione la opción para habilitar API/Whitelabel. Una vez que valide su correo electrónico, estará listo para comenzar la configuración.
Una vez que haya habilitado su usuario, puede acceder a My ClimateTrade, su área de usuario. En My ClimateTrade tendrá múltiples secciones para realizar diferentes acciones o verificar diferentes tipos de datos. Ahora vaya a la sección "Mis integraciones" (si no la ve, tal vez no seleccionó la opción para habilitar API/Whitelabel) y haga clic en el botón para crear una nueva integración, asígnele un nombre (recomendamos algo representativo de dónde se va a utilizar) y haga clic en crear integración.
¡¡¡Integración creada!!! Ahora solo necesita comprar algunos créditos de CO2 para su saldo. Si va a la sección "Mis integraciones", verá una integración creada, haga clic en ella y accederá a la página de integración. Vaya a la sección "Comprar más proyectos o recargar existentes" y siga las instrucciones para comprar algunos créditos, es tan fácil como ir a nuestro marketplace, iniciar sesión, seleccionar su proyecto preferido y al finalizar la compra seleccionar que desea usar los créditos que van a comprar para recargar el saldo de su integración.
Listos para comenzar
Una vez que tenga algo de saldo en su integración, tendrá acceso a la clave API de dicha integración.
Vaya a la página de integración, consulte la sección Integración de Whitelabel/API y verá el token que [le dará acceso a nuestra API o Whitelabel] (/products/api/). Con la clave API, está listo para comenzar a configurar nuestro Whitelabel o comenzar a desarrollar con nuestra API.
Configuración del Whitelabel
Tenemos disponible nuestro Whitelabel en marketplaces, como WooCommerce, todos con una configuración muy similar. En primer lugar, debe instalar nuestro Whitelabel o complemento en la plataforma de comercio electrónico que esté utilizando, puede encontrarlo en el marketplace de plugins (por ejemplo en el de Wordpress) y seguir las sencillas instrucciones (de un solo clic) para instalarlo.
Una vez que lo tenga, debe configurarlo. Lo primero que debe hacer es colocar la clave API proporcionada en la página de integración en la configuración del Whitelabel. Luego tiene que configurar los siguientes campos:
- % de compensación: Este es el porcentaje del valor del carrito que deseas dedicar a la compensación de emisiones. Depende de la tipología del carro pero un valor habitual rondaría el 1%
- % de pago: Este es el porcentaje del valor del carrito que le cobrará al cliente por el servicio de compensación. Si pones el mismo porcentaje que en "% de compensación", entonces todo la cantidad que el cliente paga se dedicará a la compensación, mientras que si pones más, obtendrás beneficio en cada compensación. Una cantidad habitual estaría entre el 1% y el 1,5%
- Imagen (opcional): Si desea utilizar una imagen en su Whitelabel, puede configurarla aquí.
- Título (opcional): Título del Whitelabel. Recomendamos algo breve y claro, como "Compensación de emisiones de carbono"
- Descripción (opcional): Descripción o texto que se muestra en el Whitelabel, un poco más explicativo que el título.
- CTA (Call To Action) Permite 3 modos que definirán qué tipo de información se muestra en el texto que llama a la acción
- Básico: Solo un mensaje que dice que el cliente quiere compensar la huella
- Kg: Mensaje informando de los kg que se compensarán (Kg se definen en base al % del valor del carrito dedicado a compensar y el precio del balance de CO2 de la integración)
- Con Kg e importe: Mensaje informando de Kg (igual que el anterior) más el importe que pagará el cliente (definido por % del valor del carrito dedicado al pago)
Ver un ejemplo de Whitelabel
Un Whitelabel en un comercio electrónico que ha sido configurado con un 1% de compensación y 1.5% de pago, informando tanto de los kg como del total a pagar, y con créditos de carbono comprados a 12€/tCO2. Esto debería mostrar para una compra de valor de 60€:
Compensación de 50Kg de emisiones por 0.90€.
Integración con API
Para iniciar un desarrollo de una integración por API, lo primero que deberá hacer es configurar una cuenta de pruebas. Tenemos un entorno de pruebas donde puede configurar su cuenta, comenzar su desarrollo y seguir los pasos necesarios para que una integración funcione exactamente igual que lo hará en el entorno de producción una vez que esté listo.
Aquí tienes las urls requeridas:
Entorno de Pruebas
Inicio sesión / registro
Entorno de producción
Inicio de sesión / registro
API url
Una vez que haya configurado su cuenta, tendrá acceso a una clave API, válida para el entorno en el que configuró la cuenta. Puede usar ese token o clave API para autenticar el acceso a nuestros 2 conjuntos de API (cálculo y compensación)
Para acceder a nuestra API de compensación (API que servirá para compensar las emisiones), debe agregar el encabezado "Autorización" con el valor "Token xxx", donde xxx es el valor de la clave API de su integración. Aquí tienes un ejemplo de una configuración de Postman.
Ver ejemplo de Postman
Aquí hay un ejemplo de una configuración con Postman.
Para acceder a nuestra API de cálculo (la API que necesitarás para calcular la huella de carbono de un producto/servicio específico) se tiene que añadir el Header “X-CSRFToken” wi con valor “xxx”, donde xxx es el valor de la API Key de tu integración. .
Aquí debajo se muestra un ejemplo de la configuración con Postman:
Nuestras API se pueden usar de múltiples maneras, aquí mostramos cómo sería el uso de la API en 4 casos de uso diferentes.
Ver caso de uso 1 -> Calcular, ofrecer, compensar
Este es un caso de uso donde se informa a su cliente sobre su huella de carbono, y, en caso de que quiera compensarla, se le muestra el proyecto o proyectos (en caso de dar a elegir) en los que puede compensar, para finalmente, compensar la huella
Por ejemplo en una aplicación de envío de paquetes se quiere dar la posibilidad de calcular la huella de cada envío (dependiendo de origen-destino y peso del paquete), dando la opción de compensarla eligiendo entre 3 posibles proyectos.
Ver caso de uso 2 -> Solo compensación
Este es otro caso de uso donde está usando otro método para calcular la huella de carbono o quiere compensar una cantidad de CO2 fija. Está dando a su cliente información sobre su huella, pero no opción para elegir un proyecto específico.
Por ejemplo una compañía de seguros conoce, por medio de su auditor, que la huella de suscribir una nueva póliza es de 100 KgCO2. La compañía quiere ofrecer a sus clientes la opción de compensar estos 100 KgCO2 cada vez que se contrata una nueva póliza.
Ver caso de uso 3 -> Cálculo + compensación asíncrona (en bloques o bulks)
Este es un caso de uso donde quiere informar a su cliente de su huella y del coste de compensarla pero por alguna razón no quiere compensar en el momento de la compra o reserva, si no en algún momento posterior.
Por ejemplo una web de un hotel o una agencia de viajes quiere calcular la huella de la estancia en el hotel cuando un cliente reserva una habitación, y dar la opción a dicho cliente de compensarla. Sin embargo, el hotel o la agencia quieren retrasar la compensación hasta que el cliente se aloje por si cancela el viaje poder "cancelar" la compensación.
Ver caso de uso 4 -> Importe fijo + compensación
Este es un caso de uso donde quiere dedicar un importe fijo para compensar emisiones, pero aún así puede seguir informando a los clientes de la cantidad de CO2 que compensarán con ese importe.
Por ejemplo un e-commerce que quiere dedicar un 1% del importe del carrito de compra a la compensación de emisiones.
Aquí puede ver un resumen de nuestras principales operaciones:
- Calcular las API de la huella: la huella depende del tipo de servicios/productos que estés ofreciendo. Tenemos un conjunto completo de API para calcular la huella de su servicio, [verifíquelas aquí] (#)
- Calcular la cantidad dada de compensación (calculate_offset_given_amount/). Si tiene una cantidad fija para compensar, necesita este punto final para calcular el peso de CO2 que puede compensar. Más información aquí
- Obtener proyectos (proyectos/negocio/). Este punto final le dará la información de los proyectos que tiene balanceados en su integración y su costo, necesarios para comprender el costo de la compensación. Más información aquí
- Compensa tu emisión (offset/). Este terminal ejecutará la compensación de una determinada cantidad, enviando nuestro certificado de compensación al correo facilitado. Más información aquí
Si tiene más preguntas o necesita más información, puede consultar la página dedicada a la documentación de la API.
