Banco do Brasil

Este especificação de integração ajuda a implementar a API Privada RESTful do Banco do Brasil

Entrypoint

https://{slug}.{entrypoint}.gateway.zup.me

slug

string required

Nome da Organização (Slug)

entrypoint

string required

Identificação do Ambiente da API

Enumeration:

Desenvolvimento

https://{slug}.dev.gateway.zup.me

Staging

https://{slug}.staging.gateway.zup.me

Produção

https://{slug}.gateway.zup.me

APIs expostas internamente para serem consumidas pelos sistemas internos do Banco do Brasil. Para criar uma API será preciso informar os seguintes dados:

Propriedade	Descrição
`Nome`	Define o nome da API para efeitos de identificação dentro do API Manager.
`Caminho`	Define URI base de uma API no API Manager
`Descrição`	Define descrição da API para efeitos de identificação dentro do API Manager.

Um Recurso pode ser entendido como uma unidade de informação, identificado por uma URI (Uniform Resource Identifier) única, cujas operações são definidas por um conjunto de métodos HTTP. No API Manager, cada API é composta por um conjunto de recursos. Para criar um recurso será preciso as seguintes informações:

Propriedade	Descrição
`Nome`	Define o nome do recurso, somente para efeitos de identificação dentro do API Manager.
`Caminho`	Define a URI que identifica o recurso no API Manager. Veja seção de Caminho para maiores detalhes.
`Grupo de EndPoint`	Define o grupo de endpoints responsável por atender as requisições deste recurso.

Exemplo

Exemplo de Parâmetros

Informações Técnicas

nomeRecurso - "BancoTeste" 
Caminho - "/store/product"
Grupo de endPoint - "Teste"

As solicitações devem ser feitas usando o protocolo HTTPS para que o tráfego seja criptografado. A interface responde a diferentes métodos dependendo da ação necessária.

Métodos HTTP disponíveis na API:

Método	Ação
GET	Consultar Dados
POST	Salvar/Criar Dados
PUT	Atualizar Dados
DELETE	Deletar/Inativar Dados

Um endpoint representa o endereço do servidor que responde pela API. Uma API gerenciada pelo API Manager, pode conter diversos grupos de endpoints. Cada grupo de endpoints é formado por um conjunto de endpoints, um para cada ambiente.

Propriedade	Descrição
`Nome`	Nome do grupo de endpoints. Este nome será utilizado ao referenciar o grupo de endpoints na criação de um Recurso.
`Tipo de Conector`	Define qual tipo de conector será utilizado para estabelecer a comunicação com as URLs de cada endpoint.
`Codificação do texto`	Define qual encoding o endpoint suporta. Os encodings mais comumente utilizados são ‘UTF-8’ e ‘ISO-8859-1’.

Após criar o grupo de Endpoint, será preciso informar o endereço do endpoint, conforme exemplo.

Example 1

Exemplo de Endpoints

Informações Técnicas

Produção: http://www.mocky.io/v2/58f6a9961000007e0524ef25
Homologação: http://www.mocky.io/v2/58f6a9961000007e0524ef25
Desenvolvimento: http://www.mocky.io/v2/58f6a9961000007e0524ef25

A função principal de uma aplicação é externalizar os serviços (API, recurso e método) da organização. Para isso, cada aplicação conta com uma ou mais credenciais imprescindíveis para o acesso ao serviço. Aplicações também são utilizadas para gerar estatísticas segmentadas e controlar políticas de segurança, cota e cache para cada consumidor.

Para criar aplicação será preciso informar os seguintes dados:

Propriedade	Descrição
`Nome`	Nome único que identifica a aplicação.

Ofuscação é uma funcionalidade do Zup.me que possibilita ofuscar informações sensíveis contidas requisição/resposta, que serão salvas no log. É possível ofuscar dados em todos os momentos do serviço:

Requisição do Entrypoint
Requisição do Endpoint
Resposta do Endpoint
Resposta do Entrypoint

Para criar ofuscador será preciso informar os seguintes dados:

Propriedade	Descrição
`Identificador`	Nome único que identifica o ofuscador.
`Origem`	É possível ofuscar dados a partir das origens: Path, query string, headers, cookies e payload
`Tipo`	O método utilizado para selecionar a informação. Os métodos disponíveis são: CSS, XPath, JSON e Regex
`Seletor`	O seletor que será utilizado, de acordo com tipo do ofuscador.

Example 1

Exemplo de Ofuscador

**Parâmetros para criar Ofuscador:**

Informações Técnicas

Identificador: "cardNumber"
Origem: "Payload"
Tipo: "Json"
Seletor:"$.creditCard.number"


Ao fazer uma chamada através do rest client do Zup.me, é possível testar o extrator com o
payload da requisição/resposta e visualizar o resultado, conforme mostrado abaixo.

Payload: (Colocar um exemplo)

O extrator é a ferramenta utilizada para extrair informações a partir do payload da requisição/resposta. É possível utilizar o extrator em dois momentos:

Requisição do Entrypoint
Resposta do Endpoint

Para criar extrator será preciso informar os seguintes dados:

Propriedade	Descrição
`Identificador`	Nome único que identifica aquele extrator para ser utilizado pelos modificadores.
`Origem`	É possível extrair informações do payload de uma requisição/resposta ou do resultado de uma outra extração.
`Tipo`	O método utilizado para extrair uma informação. Os métodos disponíveis são: CSS, XPath, JSON e Regex.
`Tipo Resultado`	O formato em que o resultado será apresentado.
`Query`	A Query que será utilizado, de acordo com tipo de extração, para obter a informação desejada.

Example 1

Exemplo de Extratores

Informações Técnicas

Extrator nome: @agencia
Origem: Payload
Tipo de extração: XPATH
Tipo de resultado: Objeto XML
Query: //*[local-name()="EnderecoAgencia";]
Deseja salvar na sessão: Não

teste

GET /caminho

Notes

fhdkdfdfgdfgjdfgjdfgjdjgfdj

Request parameters

name

string optional

teste

string optional

teste

Request body

Object

number

string

Número do Cartão

brand

string

Bandeira

Example:

12312312312

Responses

200 OK

Example 1

GET https://{slug}.Desenvolvimento.gateway.zup.me/caminho 

Content-Type: application/json

HTTP/1.1 200 OK