API PARA CAMPAÑAS DE DONACIÓN

Tiempo de lectura: 20 minutos Fecha: 11 Noviembre de 2017

Autor: Sergi Pallarès

2

INTRODUCCIÓN El acceso a clientes ONG de gama ‘TOP’ nos exige proporcionarles herramientas para que puedan personalizar sus campañas. La mejor forma que tiene un cliente para personalizar al máximo el aspecto de una campaña es usando nuestra primera versión de API. Este documento recoge los aspectos más básicos de una API para que cualquier persona de la organización pueda conocer qué es y cómo funciona nuestra API QUÉ ES UNA API La abreviatura viene del término en inglés Application Programming Interfaces y la definición más aceptada es que una API es una especificación formal sobre cómo un módulo de un software se comunica o interactúa con otro. Igual que una interfaz de usuario permite la interacción y comunicación entre un software y una persona, una API facilita la relación entre dos aplicaciones para el intercambio de mensajes o datos. En un entorno cliente servidor, lo que pasa cuando un cliente (navegador) solicita información a nuestro servidor es esto:

Lo que hace nuestro servidor es ‘servir’ la página entera, incluyendo nuestra hoja de estilos (diseños).

3

En un entorno cliente servidor cuando el cliente accede a nuestro servidor mediante la API lo que sucede es esto:

En este caso nuestro servidor ‘sirve’ los datos para que el cliente los dibuje como quiera. En este tipo de interacción, cuando hay una API, el servidor no envía la página ni las hojas de estilo, solamente manda los datos solicitados. Algunos ejemplos de API que usamos continuamente serían: Integración de Google Maps

4

Login para redes sociales

Procesadores de pagos

5

PORQUÉ ES IMPORTANTE TENER UNA API Hay 3 razones fundamentales por las que es importante disponer de una API:

1- Personalización. Una API ofrece a clientes ‘TOP’ la capacidad de personalizar sus campañas al máximo nivel. Este tipo de clientes disponen de recursos de diseño y suelen alejarse de las plantillas estándar. Una API nos permite ofrecerles una solución sin tener que hacerles las cosas a medida para cada uno de ellos.

2- Conexión. Las empresas punteras disponen de una o varias APIs para conectarse con terceros (Google, Facebook, Twitter, Square, Stripe, Amazon…), disponer de una API nos permite construir conexiones con las aplicaciones de nuestros clientes y fidelizarles porque les hacemos la vida más fácil cuando usan StockCrowd.

3- Innovación. Las API en general son una puerta al mundo, hacia el exterior. Personas y empresas pueden enriquecer nuestros productos y servicios con sus propios desarrollos. Podemos aprender de lo que hagan otras empresas con nuestra API para mejorar nuestra tecnología.

QUÉ HACEN NUESTRO CLIENTES CON UNA API Nuestros clientes, usando la API pueden desarrollar sus propias landing a medida para mostrar sus campañas de donación con el diseño que mejor les parezca. Ellos pueden crear sus propias páginas y ejecutarlas directamente en sus servidores. Del mismo modo, puede recoger datos de las campañas e incorporarlos en sus sistemas de CRM o gestión de participantes.

6

QUÉ ASPECTO TIENE LA API DE STOCKCROWD Este es el aspecto que tiene una API, el cliente programa una url tal y como nosotros indicamos y nuestro servidor le da la información. En esta tabla encontramos ejemplos de la landing de Sant Joan de Déu:

URL Ejemplo Respuesta: JSON https://www.stockcrowd.com/api/v1/campaign?idCampaign=<Identificador-de-campaña> Información general de la campaña

https://www.stockcrowd.com/api/v1/campaign?idCampaign=8

{ "id" : 8, "tituloCampaign" : "#paralosvalientes", "descripcion" : "Ayúdanos a construir un hospital para vencer<br> al cáncer infantil hecho entre todos", "idEmpresa" : 10, "nombreEmpresa" : "Hospital Sant Joan de Déu Barcelona", "simboloMoneda" : "&euro;", "objetivo" : 30000000.00, "recaudado" : 14461414.78, "restante" : 15538585.22, "fechaInicio" : 1487113200000, "fechaFin" : 1518735599000, "participantes" : 6159, "profesionales" : 19, "twitterTweet" : { "tweet" : "Dona ahora y ayúdanos a crear el SJD Pediatric Cancer Center Barcelona ", "hashtags" : "paralosvalientes" }, "facebookShare" : { "id" : 216, "titulo" : "Dona ahora #paralosvalientes ", "descripcion" : "Ayúdanos a crear el SJD Pediatric Cancer Center Barcelona. #paralosvalientes \r\n", "image" : { "id" : 7809, "url" : "https://stockcrowd.s3.amazonaws.com/test/resources/sc/2017/102411/StockCrowd6301398523984162114_1000.jpg", "urlThumbnail" : "https://stockcrowd.s3.amazonaws.com/test/resources/sc/2017/102411/StockCrowd6301398523984162114_400.jpg", "height" : null, "width" : null }, "video" : null }, "googleCodigoSeguimiento" : "UA-73976615-9", "facebookPixelCode" : "1835053343395649", "twitterPixelCode" : null, "hasPeerToPeer" : true }

7

https://www.stockcrowd.com/api/v1/sponsors?idCampaign=<Identificador-de-campaña>&level=<1 o 2> Sponsors de la campaña. Podremos definir Sponsors de nivel 1 o nivel 2.

https://www.stockcrowd.com/api/v1/sponsors?idCampaign=8&level=1

[ { "id" : 14, "nombre" : "", "descripcion" : "", "importe" : 0.00, "urlArchivo" : "https://stockcrowd.s3.amazonaws.com/test/resources/sc/2017/102009/StockCrowd4735264188755418130_838.jpg" }, { "id" : 67, "nombre" : "", "descripcion" : "", "importe" : 0.00, "urlArchivo" : "https://stockcrowd.s3.amazonaws.com/test/resources/sc/2017/071703/StockCrowd362248609934700063_1192.PNG" }, { "id" : 69, "nombre" : "", "descripcion" : "", "importe" : 0.00, "urlArchivo" : "https://stockcrowd.s3.amazonaws.com/test/resources/sc/2017/100506/StockCrowd4905879081197182282_886.png" }, { "id" : 81, "nombre" : "", "descripcion" : "", "importe" : 0.00, "urlArchivo" : "https://stockcrowd.s3.amazonaws.com/test/resources/sc/2017/102009/StockCrowd1362828820173238895_1200.png" }, { "id" : 121, "nombre" : "", "descripcion" : "", "importe" : 0.00, "urlArchivo" : "https://stockcrowd.s3.amazonaws.com/test/resources/sc/2017/110611/StockCrowd5839636053410201282_675.png" }, { "id" : 141, "nombre" : "", "descripcion" : "", "importe" : 0.00, "urlArchivo" : "https://stockcrowd.s3.amazonaws.com/test/resources/sc/2017/110611/StockCrowd3738454510736039598.jpg" }, { "id" : 161, "nombre" : "Nestle", "descripcion" : "", "importe" : 0.00, "urlArchivo" : "https://stockcrowd.s3.amazonaws.com/test/resources/sc/2017/112904/StockCrowd2091997816516738948.jpg" }

8

]

https://www.stockcrowd.com/api/v1/payments?idCampaign=<Identificador-de-campaña>&page=<página de resultados> Listado de participantes.

https://www.stockcrowd.com/api/v1/payments?idCampaign=8&page=0

{ "nextPage" : 1, "hasNextPage" : true, "elements" : [ { "id" : 18157, "nombre" : "User", "apellidos" : null, "fecha" : "30/11/2017 15:28", "importe" : 10.00, "anonimo" : true, "urlImagen" : null, "simboloMoneda" : "&euro;" }, { "id" : 18155, "nombre" : "User", "apellidos" : null, "fecha" : "30/11/2017 15:26", "importe" : 10.00, "anonimo" : true, "urlImagen" : null, "simboloMoneda" : "&euro;" }, { "id" : 18153, "nombre" : "User", "apellidos" : null, "fecha" : "30/11/2017 15:24", "importe" : 25.00, "anonimo" : true, "urlImagen" : null, "simboloMoneda" : "&euro;" }] }

https://www.stockcrowd.com/api/v1/faqs?idCampaign=<identificador de campaña> Listado de FAQs de la campaña.

https://www.stockcrowd.com/api/v1/faqs?idCampaign=8

[ { "id" : 102, "pregunta" : "Mi hijo/a tiene cáncer ahora, ¿puedo pedir visita en el Hospital Sant Joan de Déu de Barcelona?", "respuesta" : "<br>\nSi, el Servicio de oncología y hematología del Hospital es centro de referencia nacional para la atención del cáncer del desarrollo y de referencia internacional para determinados tipos de tumores. El centro está concertado con la sanidad pública, y además ofrece servicio de sanidad privada. Aquí, podrás consultar las diversas opciones para realizar una visita. Si procedes de un país diferente a España, consulta el apartado específico para paciente internacional en sjdhospitalbarcelona.org." }, { "id" : 73, "pregunta" : "¿Cómo se ayudará a niños con cáncer de países en vías de desarrollo?",

9

"respuesta" : "<br>\nNuestro proyecto no solo se focaliza en crear el centro. También dedicaremos los recursos para poder costear el tratamiento, la estancia y los desplazamientos de niños sin recursos económicos de todo el mundo y sus familias. <br><br>Además, se trabajará para mejorar la atención de estos niños in situ, en su propio país:<br><br>Daremos formación a profesionales de países en desarrollo.<br>\nCooperaremos con hospitales de países en desarrollo. \n" }, { "id" : 72, "pregunta" : "¿Quién impulsa el proyecto?", "respuesta" : "<br>El proyecto del <b>SJD Pediatric Cancer Center · Barcelona </b>es una iniciativa del Hospital Sant Joan de Déu Barcelona, impulsado por el propio Hospital y por el comité de Donantes Fundadores. Además, cuenta con IESE como partner académico. <br><br>Con 150 años de historia, el Hospital Sant Joan de Déu Barcelona es el primer hospital monográfico pediátrico de España. Hoy en día es un referente nacional e internacional dentro del ámbito de la salud infantil, cuya principal misión es curar y cuidar.<br><br>Curar a través de una alta especialización y con la tecnología más vanguardista. Cuidar, ubicando al paciente y su familia en el centro de todas las acciones, junto a profesionales altamente cualificados para tratar el impacto emocional que siempre tiene la hospitalización.<br>\n" }, { "id" : 70, "pregunta" : "¿Cómo se conseguirán alcanzar los objetivos?", "respuesta" : "<br>\n• Invirtiendo en tecnologías pioneras.<br>\n• Invirtiendo en investigación oncológica.<br>\n• Fomentando un modelo de atención integral y multidisciplinar al niño y a su familia: oncólogos, psicólogos, neurólogos, fisioterapeutas…<br>\n" }, { "id" : 68, "pregunta" : "¿Por qué donar para el cáncer infantil si ya dono para el cáncer en general?", "respuesta" : "<br>\nEl cáncer en niños es una enfermedad diferente al cáncer de adultos. <br><br>\n• En niños es causado por un error en el proceso de desarrollo del ser humano. Está ligado al crecimiento del niño.<br> \n• En adultos es causado por un deterioro celular debido al envejecimiento.<br><br>\nAdemás de esta diferencia, los números no ayudan a que esta enfermedad reciba la atención necesaria.<br><br>\n• Hay 1 caso en niños por cada 200 casos en adultos. La investigación se centra en el cáncer de adultos, donde la población afectada es muchísimo mayor.<br>\n• Su investigación no es rentable, de ahí el poco interés de la industria privada <br>\n• Los fondos públicos destinados a la investigación se centran en enfermedades más prevalentes.<br>\n" }, {

10

"id" : 67, "pregunta" : "¿A qué se dedicará el dinero de las donaciones?", "respuesta" : "<br>\nA la construcción del <b>SJD Pediatric Cancer Center · Barcelona</b>, un centro para vencer al cáncer infantil, accesible a niños de todo el mundo. Será el más grande de Europa y uno de los más importantes del mundo. Contará con 8.400 m2 que le permitirá atender a 400 nuevos pacientes. " } ]

https://www.stockcrowd.com/api/v1/updates?idCampaign=<identificador de campaña> Actualizaciones de la campaña (blog).

https://www.stockcrowd.com/api/v1/updates?idCampaign=8

[ { "id" : 102, "pregunta" : "Mi hijo/a tiene cáncer ahora, ¿puedo pedir visita en el Hospital Sant Joan de Déu de Barcelona?", "respuesta" : "<br>\nSi, el Servicio de oncología y hematología del Hospital es centro de referencia nacional para la atención del cáncer del desarrollo y de referencia internacional para determinados tipos de tumores. El centro está concertado con la sanidad pública, y además ofrece servicio de sanidad privada. Aquí, podrás consultar las diversas opciones para realizar una visita. Si procedes de un país diferente a España, consulta el apartado específico para paciente internacional en sjdhospitalbarcelona.org." }, { "id" : 73, "pregunta" : "¿Cómo se ayudará a niños con cáncer de países en vías de desarrollo?", "respuesta" : "<br>\nNuestro proyecto no solo se focaliza en crear el centro. También dedicaremos los recursos para poder costear el tratamiento, la estancia y los desplazamientos de niños sin recursos económicos de todo el mundo y sus familias. <br><br>Además, se trabajará para mejorar la atención de estos niños in situ, en su propio país:<br><br>Daremos formación a profesionales de países en desarrollo.<br>\nCooperaremos con hospitales de países en desarrollo. \n" }, { "id" : 72, "pregunta" : "¿Quién impulsa el proyecto?", "respuesta" : "<br>El proyecto del <b>SJD Pediatric Cancer Center · Barcelona </b>es una iniciativa del Hospital Sant Joan de Déu Barcelona, impulsado por el propio Hospital y por el comité de Donantes Fundadores. Además, cuenta con IESE como partner académico. <br><br>Con 150 años de historia, el Hospital Sant Joan de Déu Barcelona es el primer hospital monográfico pediátrico de España. Hoy en día es un referente nacional e internacional dentro del ámbito de la salud infantil, cuya principal misión es curar y cuidar.<br><br>Curar a través de una alta especialización y con la tecnología más vanguardista. Cuidar, ubicando al paciente y su familia en el centro de todas las acciones, junto a profesionales altamente cualificados para tratar el impacto emocional que siempre tiene la hospitalización.<br>\n" }, {

11

"id" : 70, "pregunta" : "¿Cómo se conseguirán alcanzar los objetivos?", "respuesta" : "<br>\n• Invirtiendo en tecnologías pioneras.<br>\n• Invirtiendo en investigación oncológica.<br>\n• Fomentando un modelo de atención integral y multidisciplinar al niño y a su familia: oncólogos, psicólogos, neurólogos, fisioterapeutas…<br>\n" }, { "id" : 68, "pregunta" : "¿Por qué donar para el cáncer infantil si ya dono para el cáncer en general?", "respuesta" : "<br>\nEl cáncer en niños es una enfermedad diferente al cáncer de adultos. <br><br>\n• En niños es causado por un error en el proceso de desarrollo del ser humano. Está ligado al crecimiento del niño.<br> \n• En adultos es causado por un deterioro celular debido al envejecimiento.<br><br>\nAdemás de esta diferencia, los números no ayudan a que esta enfermedad reciba la atención necesaria.<br><br>\n• Hay 1 caso en niños por cada 200 casos en adultos. La investigación se centra en el cáncer de adultos, donde la población afectada es muchísimo mayor.<br>\n• Su investigación no es rentable, de ahí el poco interés de la industria privada <br>\n• Los fondos públicos destinados a la investigación se centran en enfermedades más prevalentes.<br>\n" }, { "id" : 67, "pregunta" : "¿A qué se dedicará el dinero de las donaciones?", "respuesta" : "<br>\nA la construcción del <b>SJD Pediatric Cancer Center · Barcelona</b>, un centro para vencer al cáncer infantil, accesible a niños de todo el mundo. Será el más grande de Europa y uno de los más importantes del mundo. Contará con 8.400 m2 que le permitirá atender a 400 nuevos pacientes. " } ]

12

QUÉ INCLUYE Y QUÉ NO INCLUYE NUESTRA API Nuestra API conecta con el contenido dinámico de las campañas, es decir, la API es capaz de recuperar los datos de:

- Estado de la campaña: recaudación, participantes, días restantes, … - FAQs: recuperación de las FAQ subidas al back office - Blog: sincronización con el apartado de actualizaciones - Listado de participantes: recuperación del listado de participantes de la campaña - Patrocinadores: recuperación de los patrocinadores subidos al back office, tanto de

nivel 1 como de nivel 2 La API no recupera la parte del Storytelling, esta parte es la que el cliente programa a su gusto, no podemos servir el contenido del Storytelling porque el cliente no usa nuestra plantilla y no podemos ‘crear’ código html con el diseño que el cliente haya montado para su página. Un cambio en el Storytelling implicaría un cambio en el diseño de la página y nosotros en el caso de que el cliente use una API, no tenemos control sobre este diseño. LÍNEAS DE FUTURO RELACIONADAS CON LA API Lo que hemos liberado ahora como API es un conjunto de funciones básicas que permiten a un cliente montar una landing de captación de fondos a su gusto, sin embargo, tenemos que pensar en tener herramientas de desarrollo para nuestros clientes. Para ello habrá que trabajar los siguientes puntos:

• Ordenar las funciones con su correspondiente documentación • Preparar códigos de ejemplo en distintos lenguajes • Montar un site específico para desarrolladores con cuentas especiales para trabajar

en sandbox • Preparar textos legales con limitaciones relacionadas con el mal uso de nuestra API • Bloquear acceso a datos de otras campañas que no sean las del propio cliente usuario

de nuestra API • Habilitar nuevas funcionalidades:

o Conexión con recompensas y otros elementos de participación o Conexión con Peer 2 Peer o Conexión con la guía del embajador

• Convertirnos en usuarios de nuestra propia API para el desarrollo de productos y landings a medida

13

FAQ sobre nuestra API para campañas de donación 1. ¿Qué clientes puede usar la API? Todos los que tengan un plan de suscripción Enterprise, la API solamente está disponible en este plan de precios. Cualquier cliente que tenga plan Enterprise puede acceder a las funciones de la API 2. ¿Quién atiende las preguntas y dudas de los clientes relacionadas con la API? Las preguntas relacionadas con el plan precios de la API o con el envío de documentación o de ejemplos, las puede responder el departamento de soporte a los clientes. Para cuestiones relacionadas con las funciones de la API, las tecnologías servidor o cliente que puede explotarla, preguntas relacionadas con el rendimiento, …, las pasamos al departamento técnico a través de Arturo 3. ¿Qué documentación les podemos entregar? Les podemos entregar el documento con las funciones, su descripción y el código de ejemplo. 4. ¿Qué ejemplos tenemos para poder enseñar / entregar a los clientes? Les podemos entregar el html de la web de Sant Joan De Déu, como ejemplo de conexión para la API.