Configurar privacidad de APIs y métodos

Configurar privacidad de APIs y métodos

Resumen

Puedes definir la privacidad de tus APIs y métodos para otorgar acceso solo a los usuarios que desees, o revocar los accesos cuando lo requieras.


Reglas de privacidad

Puedes configurar la visibilidad de las APIs y los métodos, es decir, si estos serán públicos o privados.

El siguiente cuadro explica las posibles combinaciones de privacidad de APIs y métodos:

Privacidad
Método público
Método privado
API pública
Todos los desarolladores regitrados pueden acceder a la API y al método.


Los usuarios visitantes no autenticados pueden ver el detalle de la API y del método		Solo los desarolladores a los que haya compartido por lo menos un método de la API pueden acceder a la API y solo a los método que hayan sido compartidos


Los usuarios visitantes no autenticados pueden acceder a la API pero no pueden ver el detalle de los métodos
API privada
Todos los desarolladores regitrados pueden acceder a la API y al método.


Los usuarios visitantes no autenticados no pueden acceder a la API		Solo los desarolladores a los que haya compartido por lo menos un método de la API pueden acceder a la API y solo a los método que hayan sido compartidos


Los usuarios visitantes no autenticados no pueden acceder a la API

La visibilidad de las APIs podrá definirla al crear o editar la API, mientras que la visibilidad de los métodos al crear o editar el método. En ambos casos se motrastrará la opción con el selctor de visibilidad.

Aplicaciones

Las aplicaciones son gestionadas en el portal para desarrolladores. Los usuarios que acceden al portal pueden crear, editar y eliminar sus aplicaciones que contienen las credenciales para consultar los métodos de las APIs.

Las aplicaciones contienen una API Key que se utilizará para realizar solicitudes a los métodos cuando estos estén protegidos bajo esa modalidad. Las API Key no tienen vencimiento, aunque el usuario dueño de la aplicación puede refrescar sus valores.

Cuando su cuenta tiene activada la funcionalidad de protección de métodos mediante OAuth20, las aplicaciones contendrán un ClientId y ClientSecret que deberá ser utilizado para realizar las solicitudes a los métodos.

Configurar privacidad de API

En caso que defina la API como privada se mostrará un ícono de candado.

Debes tener en cuenta que las APIs no se comparten con los usuarios desarrolladores, lo que se comparten son sus métodos.

Configurar privacidad de métodos

Los métodos pueden estar protegidos por API Keys o mediante el protocolo OAuth2.0.

Protección mediante API Keys

Puedes proteger tus métodos mediante API Keys, configurando si deben enviarse como parámetro o como cabecera.

En caso que configure Como parámetro deberá enviarse el valor de la API Key en el parámetro auth_key.

En caso que configure Como cabecera la API Key deberá enviarse como valor de la cabecera Authorization.

Protección mediante OAuth20

Al proteger sus métodos con OAuth20 deberá completar un formulario con la configuración que corresponda.


Acceso a métodos privados

Al acceder al portal del desarrolldor, en caso que un usuario no tenga acceso al método se mostrará un mensaje informativo.



    • Related Articles

    • Crear métodos de APIs

      Resumen En el articulo Crear y gestionar versiones de APIs se mostraron los primeros pasos necearios para crear APIs. Los métodos definen la acción que se realizará sobre un determinado recurso. Como primer paso debe seleccionar la opción de Agregar ...

    • Crear y configurar API

      Resumen Las APIs serán expuestas en el portal para desarrolladores. Una API puede contener múltiples versiones, y cada una de las versiones mútiples métodos. Para crear una API debe ir a APIs > Nueva API. Configurar API Al crear una nueva API deberá ...

    • Cómo configurar Variables de contexto

      Resumen Las variables de contexto permiten asociar valores asignados a la cuenta, usuarios y aplicaciones a valores de parámetros de los métodos de las APIs. Al configurar el método de la API puedes releacionar sus parámetros a variables de contexto. ...

    • Qué es una vista de datos

      Resumen La plataforma no requiere de un proceso ETL off-line para extraer los datos desde los orígenes, sino que asociadas a la vista se encuentran un conjunto de reglas que el motor de datos interpreta para consultar la fuente a demanda o ...

    • Orígenes de datos desde Bases de datos

      Resumen El conector a Bases de datos ofrece todas las capacidades necesarias para conectarse a este tipo de orígenes. Esta opción permite recolectar datos desde diferentes tipos de bases de datos o configurar acciones de escritura, para luego crear ...