Testando API Rest

Owned by Former user (Deleted)
Last updated: Oct 17, 2024 by Marco Antonio Damo
2 min read



Nesse manual iremos lhe introduzir sobre como faz a utilização da API na prática. Esta documentação destinada a utilização da API do Portal 4BDigital.


Pré-requisitos

Antes de começar, valide os seguintes processos:



Etapa 1:  Acesso ao Swagger UI


Acesse o SwaggerUi por este acesso Swagger.


Ao acessar o link acima, você verá a seguinte página.



Etapa 2:  Escolhendo a Rest API 


Neste momento vamos selecionar para a criação de uma VM apartir da API.



Acessando a opção de Instance createInstance Using POST


Você verá a sua disposição ferramentas para criar a sua curl ou o seu codigo em Python 



Para encontrar os campos de ApiKey e a secretkey. É necessário que solicite para nosso suporte, para liberação desta opção para sua conta.


Etapa 3:  Copiando suas Keys


Após sua conta receber a permissão de utilizar a API, basta você acessar o seguinte caminho  Perfil → Informação da API


Nos campos acima voce verá suas informações da API. 


Etapa 4:  Criando a instância via API


Acessando novamente a opção de Instance createInstance Using POST


Parámetros testes para serem passados no campo instance. 


{
"computeOfferingUuid": "ccb1609b-f274-493f-9934-14c708d3f908",
        "cpuCore": "string",
        "diskSize": 0,
        "hypervisorName": "string", 
        "memory": "string", 
        "name": "teste-apiSINC",
        "networkUuid": "87fd3ef8-9399-466d-a9a8-0a8e0180c841", 
        "rootDiskSize": 0,
        "securitygroupName": "string",
        "sshKeyName": "chave-igor",
        "storageOfferingUuid": "string",  
        "templateUuid": "44a8d8cb-e84a-4678-8d7f-c07faad82bb8",  
        "zoneUuid": "bdbfe176-d2e1-444b-8ed5-75667508708b"
    }


Após preencher os campos necessários clique em Try it Out


Vai gerar um curl -X POST 


curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'apikey: NXfYaWAP_7d3eVFETXGu-udGe6Y8f8c_VFTr_0pRgViho65AJtTFvqvc8esC   ' --header 'secretkey: kdgARVgLINA3fdtZaDIt77KvfUOceJPXOgOA3GRq4N1YyGb1oDTesksFhXU5' -d '{ \
 "computeOfferingUuid": "ccb1609b-f274-493f-9934-14c708d3f908", \
         "cpuCore": "string", \
         "diskSize": 0, \
         "hypervisorName": "string",  \
         "memory": "string",  \
         "name": "teste-apiSINC",  \
         "networkUuid": "87fd3ef8-9399-466d-a9a8-0a8e0180c841",  \
         "rootDiskSize": 0, \
         "securitygroupName": "string", \
         "sshKeyName": "chave-igor", \
         "storageOfferingUuid": "string",   \
         "templateUuid": "44a8d8cb-e84a-4678-8d7f-c07faad82bb8",   \
         "zoneUuid": "bdbfe176-d2e1-444b-8ed5-75667508708b" \
     }' 'https://portal.brascloud.com.br/restapi/instance/createInstance'


Utilize esse curl, em um terminal de sua preferência.

Lembre-se que é necessário habilitar essa função na sua conta,  e também preencher os dados corretamente de acordo com a sua necessidade.