Visión general

Introducción

Primeros pasos

Desarrollo y lanzamiento

Ayuda

Ayuda

Introducción

Integración Usos

La API STACK le permite conectar STACK directamente a otras soluciones de software, creando un flujo de trabajo sin fisuras y personalizado para las necesidades de su empresa.

Las integraciones pueden utilizarse para extraer planos y documentos del proyecto, directamente desde la solución de gestión de documentos o licitaciones del proyecto de construcción, a STACK para el proceso de despegue y estimación.

También pueden utilizarse para enviar datos de estimaciones y propuestas a soluciones de software de contabilidad y gestión de proyectos.

Esto se traduce en un mejor seguimiento de los proyectos, un análisis de datos más claro, menos entradas manuales y menos repeticiones.

Entre las funciones básicas se incluyen la creación de proyectos y planos, la creación de listas medidas , la gestión de artículos y conjuntos, la recuperación de cantidades y costes, y la descarga de planos y propuestas.

Sólo se admiten las llamadas a la API publicadas en STACK Developers Reference. Los clientes que implementen puntos finales de API no publicados lo harán bajo su propia responsabilidad.

Tipos de integración

Integración personalizada - Para uso exclusivo de su empresa

Una integración personalizada es una conexión entre su cuenta STACK , que usted utiliza y controla, y otro sistema utilizado en su empresa.

Suelen crearlos los clientes de STACK para que su equipo sea más eficiente y eficaz automatizando el movimiento de datos y los flujos de trabajo manuales entre STACK y el otro sistema.

Sólo usted y su equipo tendrán acceso a su integración personalizada.

Integración de socios - Para todos los usuarios de STACK

Una integración de socio suele ser creada por otra empresa tecnológica para conectar su aplicación a STACK en beneficio de nuestros clientes mutuos.

Estas integraciones pueden publicarse en STACK Marketplace para que estén disponibles para toda la comunidad de STACK .

Encuentre aquí una lista de las integraciones de socios actuales.

Ejemplo de flujo de trabajo de integración

Antes de comenzar el desarrollo, es útil planificar cada paso del flujo de trabajo de integración propuesto y enumerar qué datos se moverán entre los sistemas asociados en cada paso.

A continuación encontrará una plantilla de flujo de trabajo en blanco y un ejemplo completado como referencia.

Requisitos

La creación de una integración con la API STACK requiere una programación que no realiza STACK.

Para utilizar la API, debe ser al menos un programador de software principiante con conocimientos básicos de lenguajes de programación, interfaces de software, autorización OAuth, API y conceptos de desarrollo web.

Si no eres programador o no tienes que tener un programador en plantilla, puedes contratar el trabajo de programación a un tercero.

Para acceder a la API, debe ser cliente de STACK y tener una suscripción habilitada para API.

Si actualmente no es cliente, pero está interesado en crear una integración de socio, póngase en contacto con nosotros para analizar su propuesta de integración y las opciones disponibles.

Primeros pasos

Solicitar acceso a la API

El primer paso para crear una integración con la API STACK es solicitar acceso a la API.

Para acceder a la API, debe ser cliente de STACK y tener una suscripción habilitada para API.

Si actualmente no es cliente, pero está interesado en crear una integración de socio, puede solicitar acceso para iniciar el debate sobre lo que le gustaría crear y cómo convertirse en socio.

En cualquiera de los casos, sólo tiene que hacer clic en el botón Solicitar acceso a la API situado en la parte superior de la página, rellenar y enviar el formulario de solicitud.

Nuestro equipo revisará la solicitud y le responderá en un plazo de dos días laborables para concertar una llamada inicial sobre la API para hablar de la integración y el flujo de trabajo propuestos.

Después de la llamada inicial, si le aprobamos para seguir adelante, le enviaremos por correo electrónico instrucciones sobre cómo configurar una cuenta de socio para obtener las credenciales de la API.

Cuenta de socio y credenciales

Para crear una integración con STACK, necesita una cuenta de socio. Se trata de una cuenta de STACK que estará vinculada a sus credenciales de API.

Aunque su integración se conecte directamente a una cuenta de cliente y no introduzca ningún dato en la cuenta de socio, se requiere una cuenta de socio a efectos de registro.

Inicialmente creará una cuenta de socio en el entorno de pruebas de aceptación de socios (PAT). (Deberá crear otra cuenta cuando pase al entorno de producción deSTACK ).

Le enviaremos por correo electrónico las instrucciones para crear una cuenta de socio después de la llamada inicial de la API.

Una vez creada la cuenta, indíquenos la dirección de correo electrónico que ha utilizado y le enviaremos un mensaje cifrado con las credenciales de la API -id de usuario y secreto del socio- necesarias para acceder a nuestro entorno sandbox/Partner Acceptance Testing (PAT).

Autenticación

Cada vez que realice una solicitud a la API STACK , deberá estar autorizado a través del servidor de autorización de STACK.

Antes de empezar a trabajar con la API, debe comprender el proceso de autorización y seguir los pasos de autenticación.

OAuth 2.0 - Autorización a dos bandas

La autorización de dos piernas se utiliza cuando su integración está escribiendo datos en o leyendo de una cuenta que usted controla. Por lo general, se trata de una comunicación de servidor a servidor en la que puede crear proyectos, planes y archivos directamente en su propia cuenta.

OAuth 2.0 - Autorización de tres patas

La autorización de tres patas se utiliza cuando tu integración está escribiendo o leyendo datos de una cuenta en nombre de un usuario. Esto requiere que el usuario conceda a tu integración permiso para controlar sus datos. Su aplicación solicitará controlar la cuenta de un usuario y éste deberá hacer clic en un botón para conceder a su aplicación los permisos adecuados.

Haga clic aquí para consultar la documentación completa sobre autenticación.

Desarrollo y lanzamiento

Entorno de pruebas - Sandbox

Creará y probará su integración en nuestro entorno de pruebas de aceptación de socios (PAT), comúnmente conocido como "sandbox".

Esto le permite rellenar datos de prueba y verificar que todas sus llamadas a la API funcionan según lo previsto antes de conectarse al entorno de producción de STACK .

Todas las integraciones deben ser certificadas en el entorno PAT por STACK antes de pasar al entorno de producción.

Consulte la sección Solicitar acceso a la API para obtener instrucciones para acceder al entorno PAT.

NOTA: Puede encontrar tutoriales para las funciones de integración más comunes en la sección Tutoriales de este sitio.

Toda la documentación de la API está disponible en Referencia API.

Certificación

Todas las integraciones deben ser certificadas por STACK antes de pasar al entorno de producción.

Esto garantiza que la API implementada funciona como se espera, proporciona una interacción segura y predecible, y puede ser soportada por STACK en el futuro.

El proceso de certificación dura unas 2 horas: usted seguirá un flujo de trabajo empresarial normal mientras nosotros supervisamos el uso de la API.

Una vez completada la certificación, se le enviarán los resultados:

- Si la integración se ha superado, recibirá instrucciones sobre cómo pasar al entorno de producción.
- Si la integración ha fallado, recibirá una lista de elementos obligatorios que deberá corregir, así como elementos opcionales para mejorar la eficacia de la integración. Una vez corregidos los elementos obligatorios, podemos repetir el proceso de certificación.

Entorno de producción

Una vez que su integración haya superado el proceso de certificación, le enviaremos por correo electrónico instrucciones para crear una cuenta de socio de producción para que pueda pasar al entorno de producción.

Una vez creada la cuenta, tendrás que comunicarnos el correo electrónico utilizado y tu clave pública. A continuación, te enviaremos un correo electrónico cifrado con las credenciales de la API de producción: ID de cliente y secreto.

En ese momento, estarás listo para empezar a trabajar. Enhorabuena.

Marca

Cuando represente a STACK en su sitio web, consulte estas directrices de marca:

- El nombre STACK debe ir siempre en mayúsculas.
- El logotipo STACK no debe manipularse ni distorsionarse en modo alguno.
- El tamaño mínimo del logotipo STACK en pantalla es de 80px de ancho.
- El tipo de letra de la marca STACK es Proxima Nova. Es el tipo de letra preferido, pero no es obligatorio. Si no utiliza Proxima Nova, asegúrese de utilizar una fuente Sans Serif segura para la web, como Arial, Helvetica, etc.

Al redirigir a un cliente a STACK desde su aplicación, un banner o botón como uno de estos puede ser apropiado:

Le proporcionaremos el archivo del logotipo y los colores utilizados en los ejemplos de botones.

Ayuda

Queremos que su conexión a la API STACK sea lo más fluida posible.

Si tiene alguna pregunta, envíe un correo electrónico a apihelp@stackct.com. (Asegúrese de incluir en el correo electrónico su nombre y su nombre de usuario en STACK ).