Saltar a contenido

Planes y excepciones

Esta página muestra cómo ves el servicio de una organización y cómo, para una organización que está debajo de la tuya, das y quitas planes, fijas excepciones, configuras un periodo de prueba y decides la fecha de fin de una demo. Qué son el servicio, los planes, las excepciones y las demos está en El servicio de tu organización.

El servicio aún no tiene pantalla en OS: lo administras mediante la API. Los ejemplos usan $OS, $TOKEN y $ORG como en Administrar grupos, y además $CUSTOMER, el id de la organización de debajo de la tuya cuyo servicio configuras.

Quién puede hacer qué

Qué Quién
Leer el servicio de una organización, con sus planes, excepciones y sus fechas su propio org-admin, y quien puede modificar su servicio
Ver quién fijó un plan o una excepción, y el motivo de una excepción quien puede modificar el servicio
Dar planes, fijar excepciones, fijar la fecha de fin de una demo un administrador de la organización superior que tenga allí org-admin con alcance descendants
Quitar un plan o una excepción un administrador así, si actúa desde la organización que lo fijó o desde una organización superior

Por eso modificas el servicio de una organización siempre desde la organización superior, nunca en la propia organización. Así un socio configura el servicio de sus clientes, y un cliente con departamentos el de sus departamentos. Lo que das queda dentro del servicio de tu propia organización: OS rechaza un plan o un elemento añadido que llegue más allá. Una excepción que quita algo siempre se puede, porque solo hace más pequeño el servicio.

Lo que Artific fijó a uno de tus clientes, no lo quitas tú como socio: solo se puede desde la organización que lo fijó, o desde una superior. Pídeselo entonces a Artific.

Los planes mismos los compone Artific. Si a un plan le falta algo que tus clientes necesitan, pídelo a tu persona de contacto en Artific.

Ver el servicio

curl -s "$OS/api/v1/organisations/$CUSTOMER/service" -H "Authorization: Bearer $TOKEN"
{"organisation_id": "org_...",
 "items": [{"kind": "agent", "actions": ["see", "use"]},
           {"kind": "knowledge_collection", "actions": null},
           {"kind": "thread", "actions": null}],
 "demo_ends_at": null,
 "allowed_actions": ["see", "write"],
 "parent_allowed_actions": ["see", "write"]}
  • items es lo que contiene ahora el servicio: sus planes y excepciones que valen ahora, dentro del servicio de la organización superior. actions: null es toda acción que conoce el tipo. Lo que contiene todo servicio (siempre en el servicio) no aparece.
  • demo_ends_at es la fecha de fin de una demo, y null para cualquier otra organización.
  • allowed_actions dice lo que puedes hacer con el servicio en la propia organización: see es leerlo.
  • parent_allowed_actions dice lo que puedes hacer con el servicio en la organización superior. Si contiene write, puedes dar y quitar planes y excepciones y fijar la fecha de fin de una demo.

Con tu propio $ORG lees así el servicio de tu propia organización.

Qué planes puedes dar

curl -s "$OS/api/v1/organisations/$ORG/assignable-plans" -H "Authorization: Bearer $TOKEN"

Son los planes de Artific que quedan dentro del servicio de tu propia organización: lo que puedes dar a las organizaciones que están debajo de la tuya. Cada plan tiene un id (pln_...), un name y sus items. La lista llega por páginas; una página puede tener menos filas que limit mientras next_cursor aún continúa.

Dar un plan

curl -s -X POST "$OS/api/v1/organisations/$CUSTOMER/service/plans" \
    -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
    -d '{"plan_id": "pln_..."}'

OS responde 201 con el plan dado:

{"id": "opl_...", "plan_id": "pln_...", "plan_name": "Asistentes",
 "starts_at": "2026-11-01T00:00:00Z", "ends_at": null, "in_force": true,
 "set_by": "...", "created_at": "2026-11-01T00:00:00Z",
 "allowed_actions": ["see", "write"]}
  • starts_at es opcional: cuándo entra en vigor el plan. Sin él, es ahora.
  • ends_at es opcional: cuándo termina el plan. Con una fecha de fin es un periodo de prueba.
  • in_force dice si el plan vale ahora.
  • id (opl_...) es el id de este plan en esta organización; lo usas para quitarlo de nuevo.
  • set_by es quién dio el plan. Los administradores de la propia organización ven aquí null.

Una organización tiene como máximo 20 planes, contando los caducados.

Ver los planes de una organización

curl -s "$OS/api/v1/organisations/$CUSTOMER/service/plans" -H "Authorization: Bearer $TOKEN"

La lista muestra también los planes caducados y los que aún han de entrar en vigor; in_force dice cuáles valen ahora. Un plan concreto lo lees con GET .../service/plans/opl_....

Quitar un plan

curl -s -X DELETE "$OS/api/v1/organisations/$CUSTOMER/service/plans/opl_..." \
    -H "Authorization: Bearer $TOKEN"

OS responde 204. El servicio de la organización se reduce de inmediato. Si quitas su último plan, vuelve a tener el servicio de la organización superior (por qué).

Fijar una excepción

Una excepción añade un elemento (add) o quita uno (remove):

curl -s -X POST "$OS/api/v1/organisations/$CUSTOMER/service/exceptions" \
    -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
    -d '{"effect": "add", "kind": "toolbox",
         "reason": "Piloto de la AI Toolbox para el equipo jurídico"}'
Campo Significado
effect add añade el elemento, remove lo quita
kind el tipo, de OS o de las funciones de IA
actions opcional: qué acciones, solo las que conoce el tipo (cuáles); omitirlo es toda acción que conoce el tipo
ends_at opcional: cuándo termina la excepción; un elemento añadido con fecha de fin es un periodo de prueba
reason opcional, como máximo 500 caracteres: por qué la fijas, como nota para quien administra el servicio

OS responde 201 con la excepción, con un id (svx_...), in_force, set_by y reason. Los administradores de la propia organización ven null en set_by y reason. Una excepción que quita algo prevalece sobre lo que dan los planes. Una organización tiene como máximo 100 excepciones, contando las caducadas.

Las excepciones de una organización las ves con GET .../service/exceptions, una concreta con GET .../service/exceptions/svx_.... Quitas una con DELETE en esa dirección; OS responde 204.

Configurar un periodo de prueba

Un periodo de prueba es un plan o una excepción añadida con ends_at:

curl -s -X POST "$OS/api/v1/organisations/$CUSTOMER/service/plans" \
    -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
    -d '{"plan_id": "pln_...", "ends_at": "2026-12-01T00:00:00Z"}'

La fecha de fin es posterior a la de inicio, o posterior a ahora si no indicas fecha de inicio. En la fecha de fin el periodo de prueba termina solo; no tienes que hacer nada. Las funciones de IA lo siguen en pocos minutos, y el registro de auditoría de la organización menciona el final. El plan caducado sigue en la lista, con in_force: false. Si el cliente quiere continuar, da el plan de nuevo sin fecha de fin y quita el plan caducado.

La fecha de fin de una demo

curl -s -X PUT "$OS/api/v1/organisations/$CUSTOMER/service/demo-end" \
    -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
    -d '{"ends_at": "2026-12-01T00:00:00Z"}'

Esto convierte la organización en una demo: en la fecha de fin se suspende, y treinta días después se borra, salvo que aún existan organizaciones debajo de ella (Demos). La fecha está en el futuro. Puedes moverla fijándola de nuevo. OS responde con el servicio, como en Ver el servicio.

Convertir una demo en una organización normal se hace quitando la fecha de fin, con {"ends_at": null}, y dándole un plan normal. Puede hacerlo cualquiera que pueda modificar su servicio. Quitar la fecha de fin no reanuda una demo suspendida: reanúdala también, como cualquier otra organización.

Si OS rechaza

Respuesta Significado Qué haces
403 No puedes modificar ni leer el servicio de esta organización, no tienes org-admin con alcance descendants en la organización superior, el plan o elemento queda fuera del servicio de tu propia organización (This is not part of your organisation's service.), o lo que quieres quitar se fijó desde una organización superior a la tuya (This was set from an organisation above yours; ask whoever set it.). Elige un plan de Qué planes puedes dar, o pide a un administrador que sí pueda, o a quien lo fijó.
404 La organización, el plan de la organización o la excepción no existe, o no llegas a ella. Comprueba $CUSTOMER y el id.
409 La organización ya tiene 20 planes o 100 excepciones, o intentas modificar el servicio de la organización más alta, que no tiene organización superior. Quita planes o excepciones caducados.
422 La solicitud no es correcta: un plan que no existe, una fecha de fin anterior a la de inicio, una fecha de fin de una demo en el pasado, un tipo desconocido, o una acción que el tipo no conoce. Lee detail o errors en la respuesta.