API de Partners de OneChat

OneChat ofrece una API de partners para nuestros socios. Encontrarás más detalles aquí: https://www.onechat.com.au/partner-api#/

OneChat ofrece diferentes endpoints para nuestros socios; puedes fácilmente:

• Obtener más información sobre el workspace, tus opciones de planes y tus opciones de add-ons.

• Actualizar o reducir planes

• Agregar o eliminar add-ons

• Habilitar o deshabilitar la renovación automática

Usando esta API de partners, puedes automatizar el proceso de ventas, reembolsos o cancelaciones bajo tu dominio personalizado.

Creación de tu token de API

Desde el dashboard de tu workspace, haz clic en el menú desplegable superior derecho, junto a tu perfil de usuario, y luego haz clic en la pestaña API keys.

Desde allí, puedes completar el nombre de tu token, seleccionar el workspace y el bot para los que deseas crear el token, y administrar los permisos. Una vez hecho esto, copia tu token.

Nota: Para la API de partners, el token debe crearse desde el workspace de Partner (se puede usar cualquier bot siempre que resida dentro del workspace del partner).

URL y autenticación

La URL base para todos los endpoints de la API será:

https://www.onechat.com.au/api

Para partners, la URL base será:

https://[Partner Custom Domain]/api

Por ejemplo, si el dominio personalizado es "app.testagency.ai", la URL base será:

"https://app.testagency.ai/api"

De forma similar, se puede acceder a todos los endpoints aquí:

https://www.onechat.com.au/api#/

Para partners, la URL white label será:

https://[Partner Custom Domain]/api

OneChat usa Bearer Token como protocolo de autorización, por lo tanto se debe enviar el siguiente encabezado en todas las llamadas a la API para la autenticación:

Authorization: Bearer {access token}

Endpoints de la API de Partners

| ### Gestión de Partners |

| --- |

| /partner/clients |

| Obtiene todos los clientes bajo el dominio del Partner |

| /partner/workspaces |

| Obtiene todos los workspaces bajo el dominio del Partner |

| /partner/workspace/create |

| Crea un nuevo workspace bajo el dominio del Partner (también crea un nuevo cliente) |

| /partner/workspace/create-for-existing-user |

| Crea un nuevo workspace para un usuario ya existente |

| /partner/workspace/{workspaceId} |

| Obtiene información sobre un workspace específico (usando GET), y también se usa para eliminar dicho workspace (usando DEL) |

| /partner/workspace/{workspaceId}/update-extra-billing-information |

| Agrega o actualiza información adicional de facturación para el workspace específico |

| /partner/workspace/{workspaceId}/list-flows |

| Obtiene los Flows/bots específicos dentro de un workspace |

| /partner/workspace/{workspaceId}/change-plan |

| Cambia o actualiza el plan actual de un workspace |

| /partner/workspace/{workspaceId}/add-addon |

| Agrega o actualiza el add-on de un workspace |

| /partner/workspace/{workspaceId}/remove-addon |

| Elimina el add-on de un workspace |

| /partner/workspace/{workspaceId}/topup-points |

| Agrega puntos a un workspace |

| /partner/workspace/{workspaceId}/deduct-points |

| Descuenta o elimina puntos de un workspace |

| /partner/workspace/{workspaceId}/enable-auto-renew |

| Habilita la renovación automática para un workspace |

| /partner/workspace/{workspaceId}/disable-auto-renew |

| Deshabilita la renovación automática para un workspace |

| /partner/workspace/{workspaceId}/pause |

| Pausa un workspace específico |

| /partner/workspace/{workspaceId}/active |

| Reanuda un workspace específico que fue pausado |

| /partner/workspace/{workspaceId}/members |

| Obtiene los miembros de un workspace específico |

| /partner/workspace/{workspaceId}/invite-member |

| Envía una invitación a un usuario para unirse a un workspace |

| /partner/workspace/{workspaceId}/remove-member |

| Elimina a un miembro de un workspace |

| /partner/workspace/{workspaceId}/install-template |

| Instala una plantilla en un workspace específico |

| /partner/plans |

| Obtiene los planes disponibles para el Partner |

| /partner/addons |

| Obtiene los add-ons disponibles para el Partner |

| /partner/webhook |

| Obtiene los webhooks activos para el Partner |

| /partner/set-webhook |

| Configura un webhook para un evento de workspace del Partner |

| /partner/remove-webhook |

| Elimina un webhook para un evento de workspace del Partner |

| /partner/templates |

| Obtiene todas las plantillas a las que el Partner tiene acceso |