API | Bling - Homologação

Homologação


Inscrição

Caso você ainda não possua uma conta no Bling clique aqui e faça a sua inscrição.

Processo

O processo de homologação é destinado a aplicativos com visibilidade pública, realizando integração com clientes do Bling.

A primeira etapa consiste na revisão do uso da API. Após, é possível solicitar a revisão do aplicativo, onde os itens serão validados pela nossa equipe técnica conforme as regras descritas na seção validação de dados.

Validação de dados

❌ Exemplo incorreto:

✅ Exemplo correto:

Logo: Deve ser condizente com a aplicação desenvolvida.

Nome do aplicativo: Nome que será exibido para os clientes do Bling.

Descrição: Descrição clara e objetiva da solução proposta pelo seu aplicativo/plataforma.

Categoria: Deve ser condizente com a solução proposta, assim o cliente poderá encontrar o seu aplicativo facilmente.

URI de redirecionamento: Conforme o fluxo de autorização, espera-se que, ao trocar o authorization_code pelo access_token, haja uma interface amigável para o usuário, tanto nos casos de sucesso quanto de erro. Esse fluxo ininterrupto facilita a experiência do usuário e a integração entre o seu aplicativo e o Bling.

URI da homepage: Recomenda-se que a página disponível pela URI possua uma descrição mais detalhada da solução que o aplicativo oferece, auxiliando, também, a promover e converter novos clientes. Aconselha-se que não necessite de autenticação para acessá-la.

Escopos: Os escopos selecionados devem possuir relação com a finalidade do aplicativo.

Os itens apresentados acima são essencialmente utilizados na revisão dos dados cadastrados. No entanto, atente-se para a criação de um serviço seguro e bem otimizado. Qualquer indício de problema que possa prejudicar os nossos usuários fará com que o aplicativo seja inativado.

Revisão

Introdução

O processo de revisão do aplicativo é iniciado através da edição de um aplicativo, clicando sobre o botão "Iniciar revisão".

Será exibida uma interface para acompanhar o processo. Caso ocorram inconsistências, elas serão exibidas e será necessário iniciar a revisão novamente.

Já se o teste for bem sucedido será possível solicitar a revisão do aplicativo para a nossa equipe técnica.

Execução

O objetivo é validar o correto uso da API, através da execução de requests sequenciais para a API de homologação.

Em uma das etapas será invalidado o access token, nesse caso, utilize o refresh token.

A cada request realizado, será retornado no header um hash que deve ser informado no header do passo seguinte.

Exemplo de retorno do header:

x-bling-homologacao: iEL06HbaOdyrjw6F0cTk6z63ZOaI0Ezn0L43++ZjY/c=

1. O primeiro request deve ser feito para obter os dados que serão utilizados para o segundo request, utilizando o método GET.

GET https://bling.com.br/Api/v3/homologacao/produtos

Exemplo de resposta:

{
	"data": {
		"nome": "Copo do Bling",
		"preco": 32.56,
		"codigo": "COD-4587"
	}
}

2. Realize o request para o endpoint de método POST, informando no body da requisição os dados obtidos no primeiro passo. Será retornado o id do produto "criado", lembrando que o id é apenas para representar um novo produto.

POST https://bling.com.br/Api/v3/homologacao/produtos

Exemplo de resposta:

{
	"data": {
		"nome": "Copo do Bling",
		"preco": 32.56,
		"codigo": "COD-4587",
		"id": 16842381880
	}
}

3. Após criar o produto, realize a alteração do atributo descricao para "Copo". Para isso utilize o método PUT, informando no path o id do produto obtido no passo anterior e no body informe os dados atualizados do produto.

PUT https://bling.com.br/Api/v3/homologacao/produtos/16842381880

Exemplo do body:

{
	"nome": "Copo",
	"preco": 32.56,
	"codigo": "COD-4587"
}

4. Altere a situação do produto utilizando o método PATCH. A situação do produto deve ser informada no body.

PATCH https://bling.com.br/Api/v3/homologacao/produtos/16842381880/situacoes

Exemplo do body:

{
	"situacao": "I"
}

5. Por fim, remova o produto por meio do método DELETE.

DELETE https://bling.com.br/Api/v3/homologacao/produtos/16842381880

Limites

O tempo total do teste deve ser de no máximo 10 segundos.

O limite entre cada requisição é de 2 segundos.

Caso o limite seja atingido, revise a implementação e refaça a operação.

Situações

As 5 situações de um aplicativo público são:

Se a situação do aplicativo for alterada, você será notificado no Bling. Caso a situação tenha sido alterada para rejeitado ou inativado, o motivo será informado na tela de edição do aplicativo.