As APIs Restful utilizam verbos para definir qual é a finalidade da requisição que está sendo enviada. Neste manual será abordado como pode ser feito um request na nossa API para cada verbo, estes são:

GET: A requisição é um pedido de dados para a API. A API vai buscar os dados solicitados em algum banco e vai retornar em formato JSON (formato de notação de objeto JavaScript);
POST: Tipo de requisição utilizada para criar um recurso em uma determinada API. São chamados de recursos o objeto que está sendo tratado naquela API;
DELETE: Requisição para excluir um dado.

Índice

Pré-requisitos

Antes de começar, valide os seguintes processos:

Etapa 1: Explicações

GET

No exemplo a seguir são listadas todas as ofertas computacionais oferecidas no portal 4BDigital:

Utilizando Curl

Curl

$ curl -G 
	--header 'Accept: application/json'
	--header 'apikey: <sua-chave-API>'
	--header 'secretkey: <sua-chave-secreta>'
	'https://portal.brascloud.com.br/restapi/compute/computeOfferingList'
	-d 'zoneUuid=bdbfe176-d2e1-444b-8ed5-75667508708b'

Utilizando Python

Python

import requests

headers = {
    'Accept': 'application/json',
    'apikey': '<sua-chave-API>',
    'secretkey': '<sua-chave-secreta>'
}

data = {
	'zoneUuid': 'bdbfe176-d2e1-444b-8ed5-75667508708b'
}

response = requests.get('https://portal.brascloud.com.br/restapi/compute/computeOfferingList', headers=headers, params=data)

POST

No exemplo a seguir é criado um novo volume no portal 4BDigital:

Utilizando Curl

Curl

$ curl -X POST 
	--header 'Content-Type: application/json' 
	--header 'Accept: application/json' 
	--header 'apikey: <sua-chave-API>' 
	--header 'secretkey: <sua-chave-secreta>' 
	-d '{ \ 
   			"diskSize": 2, \ 
   			"name": "volumeAPI", \ 
   			"storageOfferingUuid": "f304e291-8e18-4fd1-9f3d-9c4cde2c7a5f", \ 
   			"zoneUuid": "bdbfe176-d2e1-444b-8ed5-75667508708b" \ 
	}' 
	'https://portal.brascloud.com.br/restapi/volume/createVolume'

Utilizando Python

Python

import requests

headers = {
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    'apikey': '<sua-chave-API>',
    'secretkey': '<sua-chave-secreta>',
}

data = '{ \\ \n   "diskSize": 2, \\ \n   "name": "volumeAPI", \\ \n   "storageOfferingUuid": "f304e291-8e18-4fd1-9f3d-9c4cde2c7a5f", \\ \n   "zoneUuid": "bdbfe176-d2e1-444b-8ed5-75667508708b" \\ \n }'

response = requests.post('https://portal.brascloud.com.br/restapi/volume/createVolume', headers=headers, data=data)

DELETE

No exemplo a seguir é deletado um volume no portal 4BDigital:

Utilizando Curl

Curl

$ curl -X DELETE 
	--header 'Accept: application/json' 
	--header 'apikey: <sua-chave-API>' 
	--header 'secretkey: <sua-chave-secreta>' 
'https://portal.brascloud.com.br/restapi/volume/deleteVolume/9c4970f0-9725-4c79-b3ac-d9da9d6c7e09' #inserir a ID do volume a ser apagado

Utilizando Python

Python

import requests

headers = {
    'Accept': 'application/json',
    'apikey': '<sua-chave-API>',
    'secretkey': '<sua-chave-secreta>',
}

response = requests.delete('https://portal.brascloud.com.br/restapi/volume/deleteVolume/9c4970f0-9725-4c79-b3ac-d9da9d6c7e09', headers=headers)

Próximos passos: