...
Para os endpoints definidos dentro da estrutura acima, os atributos dos payloads não precisam conter o prefixo do participante, pois entende-se que todos os recursos da API estendida não conflitam de nenhum modo com as definidas pelo padrão.
Importante: Este método não deve ser usado para criar duplicações modificadas dos *endpoints* já definidos no padrão. Os novos *endpoints* devem atender às convenções e princípios do padrão, incluindo convenções de nomes e tipos de dados.
|
|---|
Novos endpoints em APIs existentes
...
Se o participante deseja adicionar um novo endpoint que resume as transações por um período, então este endpoint poderia ser definido como: <host>/open-banking/accounts/v1/accounts/{account ID}/<PID>-balance-movement
Importante: O prefixo deve ser adicionado antes do nome do recurso seguido por um hífen. (-) Como o *endpoint* é novo, os atributos do *payload* de requisição e resposta não precisam conter o prefixo do participante. Se um *endpoint* possuir múltiplos níveis na URI do recurso, apenas o recurso mais a direita deverá possuir o prefixo do participante. Os novos *endpoints* devem atender às convenções e princípios do padrão, incluindo convenções de nomes e tipos de dados.
|
|---|
Campos de retorno adicionais em um endpoint existente
...
Se um objeto estiver sendo adicionado ao payload de resposta, apenas o nome do objeto precisa receber o prefixo. Qualquer atributo dentro do novo objeto pode ser nomeado normalmente.
Importante: Campos existentes não devem ser modificados. Isto inclui adicionar novas opções em campos do tipo Enum. Um campo obrigatório não deve se tornar opcional como resultado de uma extensão. *Payloads* de requisição também podem ser estendidos, porém o resultado ainda deve respeitar os padrões definidos caso o campo de extensão não tenha sido utilizado (por definição, campos adicionais no *payload* de *request* devem ser opcionais). Parâmetros de *query* podem ser adicionados desde que seguidas as mesmas premissas de um novo campo no *payload* de requisição (com prefixo, não obrigatório e sem efeitos colaterais caso não seja informado). Parâmetros por *header* podem ser adicionados desde que seguidas as mesmas premissas de um novo campo no *payload* de requisição. No entanto, seu prefixo deve estar no formato `x--`. Novos campos devem atender os padrões definidos de nomenclatura e tipos de dados.
|
|---|
Parâmetros query adicionais
...