¿Cuál es Endpoint Security

La comunicación efectiva es el factor más importante para el éxito de la API. API no tienen una interfaz de usuario, por lo que la documentación es el método principal de comunicación para que los desarrolladores interactúan con su API. Como mi compañero de entrenamiento API Keith Casey afirma,. Su documentación de la API debe ser integral Como se ha comentado anteriormente, nuestra documentación de la API necesita y en todos los aspectos del ciclo de vida de la API. A diferencia del típico producto basado en SaaS, sin embargo, la documentación tiene que dirigirse a una variedad de públicos, desde los responsables de tomar decisiones a los desarrolladores en última instancia, la integración con ella. No hay garantía de qué tipo de miembro de la audiencia se encontrará con su API en primer lugar, por lo que su esfuerzo de documentación ha de ser global. Su documentación de la API debe responder a 10 preguntas clave para iniciar su viaje documentación de la API, que ayuda a concentrarse en las preguntas que los miembros de su público le pida. Desde la primera vez que encuentran su API, a su "hola App World 'inicial, y más allá de las preguntas quese están preguntando amplio. Ser capaz de responder a estas preguntas le ayudará a su audiencia a entender mejor lo que sus problemas resuelve la API, comprometerse con su primera integración, y responder a sus preocupaciones ya que consideran la adopción formal de su API. Pregunta # 1: ¿Tiene una API? El hecho de que vive y respira su API no significa que otros sabe que tiene uno. Su sitio web y materiales de marketing corporativos son puntos de entrada clave para aquellos que no pueden saber lo que ofrece una API. Sea explícito sobre el ofrecimiento de la API, como productos a base de API son todavía un concepto nuevo para muchos que se asuma que su producto es un lugar SaaS. La documentación debe llamar la atención sobre su oferta de API, detalle los problemas de los que resuelve, y enlace a su portal de desarrolladores. Además, recuerde que si su portal de desarrolladores está haciendo su trabajo en relación con la optimización de motores de búsqueda (SEO), entonces no son desarrolladores pueden suceder en su portal de desarrolladores también. Por lo tanto, ofrecer maneras para volver al resumen de su producto para aquellos que no lofamiliarizados con las API. O mejor aún, les ayudan a aprender un poco más acerca de sus ofertas de productos y API al mismo tiempo. Pregunta # 2: ¿Qué puedo hacer yo (y no hacer) con su API? Una vez que el público comienza a explorar su API, lo que necesitan saber lo que hace (y no lo hace). Comience con los problemas de su API tiene como objetivo resolver en primer lugar, a continuación, pasar a las características de su API que resuelven estos problemas. Al centrarse en los problemas y las soluciones resultantes, que se centran en la necesidad en lugar de los puntos finales de API específicas. Esto se logra a menudo a través de: las guías de introducción, guías de integración / soluciones y aplicaciones de referencia - todos dispersos con una gran cantidad de ejemplos de código y fáciles de leer que se pueden utilizar como punto de partida una vez que comienza el desarrollo. Nadie se preocupa por su API muy bien diseñado, si no saben qué tipo de problemas se pueden resolver por ellos. Tanto los responsables de las decisiones y los desarrolladores están tratando de resolver los problemas, no añadir más integraciones de API a su base de código. Encontrar los problemas, ofrecer unasolución y, a continuación detalladamente algunas de las características interesantes de su API para reforzar el valor de su API. Pregunta # 3: ¿Tiene su API de adaptarse a las necesidades de mi empresa? Una vez que establezca los tipos de problemas que sus direcciones de API, el siguiente paso es asegurarse de que su API se alinea con sus necesidades específicas y su identidad. Parte de ofrecer un producto API está posicionando su producto de manera que se ve como la solución adecuada para ellos * *. Al ofrecer a los casos de uso, casos de estudio y ejemplos de aplicaciones, su producto es fácilmente alineada con los tipos de segmentos de clientes que desea atraer (y como resultado se centrará menos en otros segmentos). Estos activos documentación también construye la confianza que los clientes empiezan a ver empresas similares como a sí mismos, haciendo que se imaginan resolver problemas similares. Pregunta # 4: ¿Cuánto cuesta? En última instancia, el precio va a convertirse en un factor. Si llegado hasta este punto, que al menos han pasado tiempo proceder a la instrucción de su solución de API y ahora quiere saber si va a cumplir con su presupuesto. Sea por adelantadocon sus precios. No oculte su precio detrás de un enlace de "Llámanos". Esto no quiere decir que no se puede ofrecer una licencia empresarial que requiere una llamada telefónica, sin embargo. Como mínimo, proveer suficiente información de precios para ayudarles a entender su modelo de precios (por ejemplo, la suscripción, por transacción), niveles de suscripción (por ejemplo, libre, en solitario, el equipo de la empresa), y qué tipo de apoyo está disponible para cada nivel (por ejemplo, foros, correo electrónico, teléfono 48 horas, teléfono 24 horas, el teléfono 4 hora). Ser por adelantado con sus precios ayuda a los encargados de realizar la investigación y les impide eliminar de su lista corta debido a su política de precios más cerrada. Pregunta # 5: ¿Cómo ve su API de mi mundo? Cada API se aproxima a una solución a un problema de una manera diferente. La API lleva consigo una visión específica del mundo: ¿Cómo se explica media, los tipos de flujos de trabajo compatibles, y el tipo de datos considera importante. A modo de ejemplo, consideremos tres API de gestión de proyectos populares:, y. Cada uno tiene diferentespuntos de vista sobre los proyectos ¿Cómo debe organizarse, cómo se deben crear las tareas, y la forma en que están marcados como completada. Dependiendo de cómo su organización prefiere administrar proyectos determinará qué solución es la mejor opción para usted. Por lo tanto, es importante para documentar sus conceptos API, recursos, estructuras de datos, y los tipos de campo. Si lo hace, proporcionará una mayor comprensión de cómo su API ve el mundo y la solución a los problemas que enfrenta su público. Mientras que algunos documentación de referencia de API de vista como el lugar para hacer eso, recomiendo a menudo usando Markdown o guías introductorias basados ​​en HTML para captar conceptos, vocabulario común y definiciones de recursos de alto nivel. Cuando se espolvorean con etiquetas de anclaje para enlaces profundos, la documentación de referencia de la API se puede vincular a los conceptos específicos útiles para el recurso / punto final específico que se está viendo. Pregunta # 6: ¿Cómo se protege su API? Seguridad de su API es importante, sobre todo con la API en las noticias. Con demasiada frecuencia, sin embargo, la seguridad es unaidea de último momento en la construcción de las API. Casi todas las API proporcionará acceso a datos sensibles, los sistemas internos de negocio, o compartir datos de usuario. Por adelantado consideraciones de seguridad impiden último minuto cambios en el diseño de la API que hacen que el API más difíciles de usar. La documentación debe proporcionar detalles sobre cómo su API controla la autenticación, autorización y seguridad de los datos (tanto la seguridad en el movimiento y la seguridad en reposo). Esto reenforce dedicación de su producto a un servicio profesional de calidad de la producción que se destacan frente a los competidores. Pregunta # 7: ¿Cuánto tiempo se necesita para empezar? Mientras que muchas APIs web modernos ofrecen incorporación de autoservicio, no todas las API hace. Si su API sí ofrece incorporación de autoservicio, llamar a esto en la documentación como un beneficio para empezar más rápido. Para aquellos que requieren tiempo para pasar por un programa de asociación, incluir esto en su documentación, así. Esto asegurará que el tiempo de espera adecuado se tiene en cuenta antes de comenzar los desarrolladoresla primera integración 'hola mundo'. También es una buena idea para que apunte a las aplicaciones de ejemplo que se han construido con una variedad de lenguajes de programación, como una manera de empezar rápidamente. Recomendamos el uso u otro repositorio de código fuente público, por lo que los desarrolladores pueden clonar rápidamente sus ejemplos, configurar su clave de API o token de OAuth, y probar su API. Pregunta # 8: ¿Se ofrecen las bibliotecas cooperadoras / SDK? No todos los desarrolladores quieren codificar el cliente HTTP desde cero. Este es particularmente el caso de los desarrolladores que son nuevas para la integración API web, o para aquellos que prefieren utilizar su IDE y finalización de código para hacer su trabajo más rápido. Si usted ofrece SDK, hacer referencia a ellos en su documentación, así como en los ejemplos de código. es un gran ejemplo de la integración de ejemplos en múltiples lenguajes de programación en su documentación. Pregunta # 9: ¿Qué puntos finales de API e integraciones de eventos ofrece su API? Usted se dará cuenta de que nos estamos acercando al final de nuestras preguntas y hasta ahora no ha APIdocumentación de referencia. de una estrategia completa documentación de la API, a pesar de que es muy importante. La documentación de referencia de la API debe enumerar todos los puntos finales de API disponibles, incluyendo detalles acerca de las estructuras de datos, el éxito / códigos de estado de error devueltos, y solicitud / formatos de carga útil de respuesta. Tenga en cuenta que esta documentación de referencia debe ser minuciosa y completa, ya que los desarrolladores externos no tendrán acceso a su código fuente, diagramas internos, o documentación privada. Recuerde que no todas las integraciones de API son los patrones de comunicación de una sola vía. Encuentra la manera de ofrecer, permitiendo a sus clientes API para hacer solicitudes de la API cuando sea necesario ( "pedir") y ser informado de los eventos del lado del servidor específico ( "decir"). Ya sea que decida usar WebHooks, WebSockets, o SSE, encontrar la manera de extender su diseño API más allá del diseño simple de solicitud / respuesta. A continuación, ofrecer documentación acerca de estas opciones de integración para mostrar cómo los desarrolladores pueden ampliar los escenarios de integración típicos con opciones más robustas.Pregunta # 10: ¿Por qué aparece el código de error o una respuesta inesperada? Una vez que los desarrolladores comiencen a trabajar con su API, es probable que se produzcan errores inesperados. documentos de apoyo ofrecen con preguntas frecuentes, guías de solución de problemas y soporte para desarrolladores para ayudar a superar estos problemas y tener éxito. Documentación que consta de las guías de introducción sólo debe considerarse incompleta. (Bonus) Pregunta # 11: ¿Qué hago si yo no soy un programador? No todos los visitantes a su página de producto API serán desarrolladores. Para aquellos que no lo son, mostrarles maneras de utilizar sus APIs a través de herramientas tales como /, un mercado de soluciones de terceros, o una página de socios de integración. Aún mejor, darles una demostración de su API a través de una web sencilla o aplicación móvil para despertar su imaginación y hacer que tomar medidas.