Saltar al contenido principal
Un socio puede llamar a BC Correios con su propia credencial. En BC Correios, limitas esa credencial a algunos correos. Esta página muestra cómo elegir ese ámbito, qué alcanza y qué recibe el socio cuando sale de él. Todo socio de BC Correios necesita un ámbito: al menos un correo.

Paso a paso

1

Elige con qué trabaja el socio

Una instalación de BC Correios atiende a una institución, así que el correo es el único elemento al que puedes limitar a un socio. El campo de la API es el field de una entrada de ámbito; la Console muestra el nombre de la primera columna.Cada valor es el ID que BC Correios devuelve para el correo.El catálogo de ámbito lista la restricción de BC Correios. Léelo con Consultar el catálogo de ámbito de un producto para plugin-bc-correios.Algunas reglas valen para todo ámbito:
  • Una solicitud que no nombra un correo se rechaza. Por ejemplo, un socio no puede listar ni contar los correos de tu institución: lee solo los correos cuyos IDs le das.
  • Una query que lista varios correos se rechaza cuando cualquiera de ellos está fuera del ámbito.
  • Las rutas que actúan sobre toda la instalación se rechazan a todo socio: la configuración, el dashboard, la exportación de la auditoría, la configuración en tiempo de ejecución y el manifiesto de streaming.
2

Da al socio sus permisos y su ámbito

Crea el socio, o cámbialo, en la Console o con la API de Identity. El slug del producto es plugin-bc-correios.
  • Agrega al menos una entrada de ámbito para BC Correios. Sin ella, Access Manager rechaza el socio con 400 y IDE-1060.
  • Revisa los recursos y las acciones. Lo máximo que puedes dar es lo que tiene el rol plugin-bc-correios-editor-role en tu tenant.
Access Manager verifica cada escritura que das contra el ámbito. Una escritura que actúa sobre toda la instalación nunca se da a un socio, y se rechaza con 400 y IDE-1056. La Console marca la línea como Outside the scope. En BC Correios, esas escrituras son crear y cambiar la configuración, probar las conexiones con BC Correio y con la IA, y cambiar la configuración en tiempo de ejecución.Las escrituras que un socio puede recibir son mails con post (una respuesta, un nuevo análisis de IA) y mails con put (archivar, restaurar).
3

Crea su aplicación de BC Correios

Crea la aplicación del socio con el producto plugin-bc-correios. Consulta Crea las aplicaciones del socio en la guía de la API, o en la Console. Envía el client ID y el client secret al socio por un canal seguro.
4

Indica al socio cómo nombrar sus correos

En la mayoría de las rutas el correo ya está en el path. En las otras, el socio lo nombra en la query o en el cuerpo que BC Correios ya tiene. Toda ruta de abajo usa la ruta base /api/v1/correios.
Un socio nunca lista correos: dale el ID de cada correo con el que debe trabajar, y agrega ese ID a su ámbito. Un correo que llega después no está en el ámbito hasta que lo agregas.
5

Confirma que funciona

Esta comprobación supone que el socio tiene el recurso mails con la acción get en BC Correios, y un ámbito con un correo. Usa la credencial del socio. Lee el correo de su ámbito. La respuesta es 200:
Envía la misma solicitud con un correo fuera del ámbito. La respuesta es 403. Para ver el código, quita -o /dev/null: el cuerpo de la respuesta trae BCC-1003.

Si algo falla

La respuesta no dice si fueron los permisos o el ámbito los que rechazaron la solicitud. Es a propósito: un socio no puede usar un rechazo para saber qué correos existen fuera de su ámbito. Para cualquier otro código, consulta la lista de errores de BC Correios. Para los rechazos al crear o cambiar un socio, consulta Códigos de error en la guía de la API.