Pular para o conteúdo principal
Um parceiro pode chamar o Reporter com uma credencial própria. No Reporter, você restringe essa credencial a algumas instituições, a alguns templates, ou aos dois. Esta página mostra como escolher esse escopo, o que cada escolha alcança e o que o parceiro recebe quando sai dele. Todo parceiro do Reporter precisa de escopo: pelo menos uma instituição ou um template.

​
Passo a passo

1

Escolha com o que o parceiro trabalha

Escolha o escopo mais estreito que cobre o que o parceiro precisa. Cada linha é uma restrição que você pode adicionar. O campo na API é o field de uma entrada de escopo; o Console mostra o nome da primeira coluna.As duas restrições podem ser combinadas. Um parceiro restrito pelas duas nomeia uma instituição e um template do escopo dele em toda requisição sobre relatórios, e lê um relatório por ID só sob os dois. Cada valor é o ID que o Reporter devolve quando você cria a instituição ou o template.O catálogo de escopo lista todas as restrições do Reporter. Leia-o com Consultar o catálogo de escopo de um produto para reporter.Algumas regras valem para todo escopo:
  • Uma requisição que não nomeia um item de um tipo restrito é recusada quando atua sobre relatórios. Por exemplo, um parceiro restrito a algumas instituições não pode listar todos os relatórios do seu tenant.
  • Uma query que lista vários valores é recusada quando qualquer um deles está fora do escopo. Um campo de corpo aceita um valor: uma lista nele é recusada com 400.
  • As rotas que atuam sobre o tenant inteiro são recusadas a todo parceiro: fontes de dados, prazos, métricas, eventos, as listas de templates e de instituições, o catálogo regulatório, as inscrições regulatórias e os mapeamentos delas, e as correções, a aprovação e a proveniência de uma remessa regulatória.
2

Dê ao parceiro as permissões e o escopo

Crie o parceiro, ou altere-o, no Console ou com a API do Identity. O identificador do produto é reporter.
  • Adicione pelo menos uma entrada de escopo do Reporter. Sem ela, o Access Manager recusa o parceiro com 400 e IDE-1060.
  • Marque os recursos e as ações. O máximo que você pode dar é o que o papel reporter-editor-role tem no seu tenant.
O Access Manager confere cada escrita que você dá contra o escopo. Uma escrita que atua sobre o tenant inteiro nunca é dada a um parceiro, e é recusada com 400 e IDE-1056. O Console marca a linha como Fora do escopo. No Reporter, essas escritas são:
  • Criar, alterar ou excluir templates, fontes de dados, prazos e instituições.
  • Alterar ou excluir uma inscrição regulatória e o mapeamento dela.
  • Aprovar uma remessa regulatória (regulatory-approval).
As escritas que um parceiro pode receber são reports com post, para gerar relatórios, e regulatory com post, para inscrever as próprias instituições e gerar as remessas delas.
3

Crie a aplicação dele no Reporter

Crie a aplicação do parceiro com o produto reporter. Veja Criar as aplicações do parceiro no guia da API, ou no Console. Envie o client ID e o client secret ao parceiro por um canal seguro.
4

Diga ao parceiro como nomear os itens dele

Nas rotas que leem um relatório, o path traz a instituição, o template ou os dois, conforme a rota que o parceiro escolhe. Nas outras rotas, o parceiro os nomeia nas queries e nos corpos que o Reporter já tem. Só as restrições que o parceiro tem são conferidas: cada valor que ele nomeia para uma delas tem que estar dentro do escopo dele. Um parceiro restrito só por template pode nomear qualquer instituição.Um parceiro lê um relatório por ID só pelas rotas que nomeiam a instituição ou o template dele. GET /v1/reports/{id} e o /download dele são recusados a todo parceiro. Para gerar uma remessa, um parceiro usa /v1/institutions/{institutionId}/regulatory/reports. POST /v1/regulatory/reports é recusado a todo parceiro.Um relatório de outra instituição ou de outro template, pedido sob o path do próprio parceiro, responde 404 com RPT-0011. É a mesma resposta de um ID que não existe. O mesmo vale para uma inscrição regulatória de outra instituição, enviada sob a instituição do próprio parceiro.
O que o parceiro vê num relatório é o que o template e a fonte de dados leem. O Reporter limita as linhas a uma instituição só pelo escopo da instituição: as linhas de cada fonte de dados que pertencem a ela. Antes de dar uma instituição a um parceiro, confira se o escopo da instituição nomeia as linhas dela em toda fonte de dados que os templates dele leem.Um parceiro restrito só por template não fica limitado a uma instituição: ele pode gerar os templates dele para qualquer instituição. Dê a esse parceiro templates e fontes de dados feitos só para ele. Se um parceiro lê linhas que não são dele, o template, a fonte de dados ou o escopo da instituição está configurado errado. É um erro de configuração, não de autorização, e a correção está nessa configuração.
5

Confirme que funciona

Esta conferência supõe que o parceiro tem o recurso reports com a ação get no Reporter, e um escopo restrito a uma ou mais instituições. Use a credencial do parceiro. Leia um relatório de uma instituição dentro do escopo dele. A resposta é 200:
Envie a mesma requisição com uma instituição fora do escopo. A resposta é 403. Para ver o código, tire o -o /dev/null: o corpo da resposta traz AUT-1020.

​
Se algo falhar

A resposta não diz se foram as permissões ou o escopo que recusaram a requisição. Isso é proposital: um parceiro não consegue usar uma recusa para descobrir quais instituições ou templates existem fora do escopo dele. Para todos os outros códigos, veja a lista de erros do Reporter. Para as recusas ao criar ou alterar um parceiro, veja os códigos de erro no guia da API.