Una conexión permite guardar de manera segura las credenciales de API que se van a utilizar con un servicio o sistema, como Slack o Shopify. Una conexión se puede usar para autenticar las llamadas de API de REST en el pasoHacer llamada de APIdel generador de flujos. Para crear conexiones, es necesario ser un administrador.
Acerca de las conexiones
Las conexiones admiten uno de los siguientes métodos de autenticación de la API:
- Clave API
- Autenticación básica
- Token de portador
El método de autenticación determina el tipo de credenciales que almacena la conexión. Por ejemplo, una conexión de autenticación básica almacena un nombre de usuario y una contraseña. Después de que se crea una conexión, no se puede cambiar su tipo de autenticación.
Distintas API admiten distintos métodos de autenticación. Para determinar el método de autenticación apropiado para una llamada de API, consulte la documentación de la API correspondiente.
Encabezados de HTTP para tipos de autenticación
| 蒂波德autentificación | Encabezado de HTTP |
|---|---|
| Clave API | Se establece cuando se crea la conexión. ConsulteEncabezados de HTTP para las claves API. |
| Autenticación básica | Authorization: Basic |
| Token de portador | Authorization: Bearer |
Si desea más información sobre cómo usar una conexión en el generador de flujos, consulteUtilización del paso Hacer llamada de API en el generador de flujos.
Crear una conexión
Se puede crear una conexión en el Centro de administración desde la página Conexiones.
Para crear una conexión
- En elCentro de administración, haga clic en
Aplicaciones e integracionesen la barra lateral y luego seleccioneConexiones > Conexiones. - Haga clic enCrear conexion.
- Seleccione un tipo de autenticación.
- Ingrese un nombre para la conexión. Después de crear la conexión, no se puede cambiar este nombre.
- Configure las credenciales de autenticación de la conexión. La conexión utiliza estos detalles para autenticar las llamadas de API de REST al servicio o sistema.
- Ingrese un dominio permitido para la conexión. Después de crear la conexión, no se puede cambiar el dominio permitido. Si desea más información, consulteDominio permitido.
- Haga clic enGuardarpara crear la conexión.
Después de creada la conexión, puede ver los detalles en la página Conexiones en el Centro de administración. ConsulteAdministración de conexiones.
Dominio permitido
联合国每conexion requiere滑道主机de URL有限公司mo dominio permitido. Zendesk solo pasa las credenciales de la conexión en las llamadas de API a este nombre de host. Cualquier intento por usar la conexión con otros nombres de host producirá un error. Esto ayuda a evitar una filtración accidental de las credenciales de la conexión. Después de que se crea una conexión, no se puede cambiar su dominio permitido.
Por ejemplo, solo se puede usar una conexión con un dominio permitido de "api.example.com" para hacer llamadas de API al nombre de host “https://api.example.com”.
Requisitos para el dominio permitido
El dominio permitido de una conexión no puede exceder 128 caracteres. Un subdominio o dominio en el valor no puede exceder 63 caracteres. El valor debe contener un nombre de dominio válido.
Una conexión siempre usa un esquemahttps. No se admite ningún otro esquema, comoftps.
Comodines para el dominio permitido
El dominio permitido de una conexión admite un subdominio de comodín (*) opcional. Esto permite usar la conexión con el dominio ápex y cualquier subdominio. Por ejemplo, se puede usar una conexión con un dominio permitido de*.example.compara autenticar las llamadas de API a "example.com" o cualquier subdominio de "example.com".
Para usar un subdominio de comodín, los dos primeros caracteres del dominio permitido deben ser*.. No se puede usar un comodín en otras partes del nombre de host. Por ejemplo, no se puede usar un comodín dentro de un nombre de host, comoexam*.com, o bienmy-*.example.com.
No se puede usar un comodín con solo unsufijo de dominio público, como*.com,*.com.au, o bien*.myshopify.com. Si desea ver una lista de sufijos públicos, consulte lalista de sufijos públicosque se encuentra en publicsuffix.org.
Encabezados de HTTP para las claves API
Cuando se crea una conexión de clave API, se debe especificar un nombre de encabezado de HTTP. Cuando se usa la conexión para hacer una llamada de API, Zendesk pasa la clave de API como el valor para este encabezado.
Muchas API usan un encabezado personalizado para aceptar las claves API. Para obtener el nombre del encabezado apropiado para una llamada de API, consulte la documentación de la API correspondiente.
Requisitos para el nombre del encabezado
El nombre del encabezado de una conexión de clave API no puede exceder 128 caracteres. El nombre del encabezado solo puede contener letras, guiones normales (-) y guiones bajos (_).
acceptaccept-charsetaccept-encodingaccept-languagecache-controlconnectioncontent-md5cookiedateexpectfromhostif-matchif-modified-sinceif-none-matchif-rangeif-unmodified-sincemax-forwardspragmaproxy-authenticateproxy-authorizationrangeserverreferertetrailer传输编码upgradeuser-agentviawarningwww-authenticate- Los nombres de encabezados que comienzan por:
x-amz-
x-amzn-x-forwarded-x-zis-
0 Comentarios
Inicie sesiónpara dejar un comentario.