Introdução - Blockradar

Antes de começar!
Você deve criar uma conta gratuita do Blockradar para testar a API. Forneceremos chaves de teste que você pode usar para fazer chamadas à API.

Coleção do Postman

Visualizar a Coleção do Postman

A API do Blockradar oferece acesso a praticamente todos os recursos que você pode usar em nosso painel e permite estendê-los para uso em seu produto. Ela se esforça para ser RESTful e está organizada em torno dos principais recursos com os quais você estaria interagindo - com algumas exceções notáveis.

Requisições de Exemplo

Fornecemos chamadas de API de exemplo ao lado de cada método usando cURL. Tudo o que você precisa fazer é inserir seus parâmetros específicos e testar as chamadas pela linha de comando. Veja este tutorial sobre usando cURL com APIs. Você também pode usar o Postman se não estiver familiarizado com o cURL. O Postman é uma plataforma fácil de usar para desenvolvimento e teste de APIs. Você pode explorar a Coleção do Postman do Blockradar para entender como nossas APIs funcionam.

Requisições e Respostas

Tanto os dados do corpo da requisição quanto os dados da resposta são formatados como JSON. O tipo de conteúdo para respostas será sempre application/json. Geralmente, todas as respostas estarão no seguinte formato:

{
  "statusCode": "[number]",
  "message": "[string]",
  "data": "[object]"
}

Chaves

Propriedade	Tipo	Descrição
statusCode	number	Este é o código de status da requisição que permite saber se sua requisição foi bem-sucedida ou não. Recomendamos que você use isso para determinar o resultado de uma chamada de API.
message	string	Este é um resumo da resposta e seu status. Por exemplo, ao tentar recuperar uma lista de clientes, a mensagem pode dizer “Transações obtidas com sucesso”. No caso de um erro, a chave message conterá uma descrição do erro, como na situação do cabeçalho de autorização acima. Esta é a única chave que é universal em todas as requisições.
data	object	Contém os resultados da sua requisição. Pode ser um objeto ou um array, dependendo da requisição feita. Por exemplo, uma requisição para recuperar uma única transação retornará um objeto de transação na chave data, enquanto a chave seria um array de transações se uma lista for solicitada.

Objeto Meta

A chave meta é usada para fornecer contexto para o conteúdo da chave data. Por exemplo, se uma lista de transações realizadas por um cliente estiver sendo recuperada, parâmetros de paginação podem ser passados para limitar o conjunto de resultados. A chave meta conterá então um objeto com os seguintes atributos:

{
 "meta": {
    "totalItems": 704,
    "itemCount": 100,
    "itemsPerPage": 100,
    "totalPages": 8,
    "currentPage": 1
  }
}

Propriedade	Descrição
totalItems	O número total de itens disponíveis. Representa a contagem completa de itens em todas as páginas.
itemCount	O número de itens na página atual. Indica quantos itens estão sendo retornados na resposta atual.
itemsPerPage	O número máximo de itens por página. Define o limite de paginação definido para cada página. Padrão: 100
totalPages	O número total de páginas disponíveis. É calculado com base no número total de itens e no número de itens por página.
currentPage	O número da página atual. Indica qual página da paginação está sendo retornada na resposta atual. Padrão: 1

Coleção do Postman

​Requisições de Exemplo

​Requisições e Respostas

​Chaves

​Objeto Meta

Requisições de Exemplo

Requisições e Respostas

Chaves

Objeto Meta