API Key maestra para Partner API
¿Qué es? ¿Cuál es el caso de uso?
Como partner, gestionar múltiples workspaces puede tomar tiempo y esfuerzo. Anteriormente, necesitabas API Keys separadas para cada workspace. Sin embargo, con esta nueva funcionalidad, tendrás una sola API Key maestra. Puedes usar esta clave, cualquier ID de workspace y tu dominio personalizado para gestionar ese workspace de forma eficiente.
Imagina crear un nuevo workspace a través de la API. Al crearlo, recibes un ID de workspace en la respuesta. Después, usando la API Key maestra junto con el ID del workspace, puedes realizar cambios en ese workspace de forma dinámica y automática.
Obtener la API Key maestra:
Primero, obtén la API Key maestra desde tu workspace principal de partner. Asegúrate de haber iniciado sesión en tu workspace principal de partner, ve a API keys, y cualquier API Key dentro de este workspace funcionará como tu API Key maestra.
Encontrar tus endpoints de Partner API:
Cambia a tu workspace, entra a API keys y haz clic en API documentation. Asegúrate de haber iniciado sesión desde tu dominio personalizado para ver tus endpoints de API específicos.
Agregar parámetros adicionales:
Se deben incluir dos parámetros adicionales en el header de la solicitud:
- Scope de manage team: solo necesitarás
x-client-workspace-id
- Scope de manage flow: necesitarás
x-client-flow-nsyx-client-workspace-id
Si el scope es "manage team", solo es necesario el parámetro del ID del workspace.
Estos parámetros dependen del scope de tus endpoints de API. Si el scope es "manage flow", ambos parámetros son obligatorios.
Configurar External Request:
Crea un External Request y configúralo como se muestra en la imagen:
1. En Header, establece los parámetros x-client-flow-ns y x-client-workspace-id
1. Ingresa tu API Key en Authorization
1. Ve a all bots y copia tu flow ns.
**Respuesta:** Si el código de retorno es 200, indica que la operación fue exitosa.
Tutoriales en video
TODO_VIDEO[d75deb7fbe]: reemplazar este video con un recurso oficial de OneChat.
FR4