API

A REST API de serviços da iVipCoin, foi desenvolvida com a mesma tecnologia de debug e compilação pensada para o front-end do sistema, o que seja, utilizando o Node.js no lado do servidor. Permitindo que toda a estrutura do complexo sistema da iVipCoin, seja desenvolvida na mesma linguagem de programação, seja ele JavaScript ou TypeScript.

A primeira coisa a entender é, a REST API da iVipCoin será processada com as informações de entrada por via parâmetros (definidas na própria url a partir do "?") ou por via corpo de solicitação (dados enviados pelo header). A conclusão desse processo será exibido em formado JSON com o seguinte padrão:

{
    "version"        : "1.0", //versão da API utilizada
    "code"           : 200,   //código de resposta HTTP
    "status"         : "OK",  //estado da requisição
    "response"       : [],    //resposta da requisição
    "description"    : "",    //descrição da requisição
    "requisitionTime": {
        "start"   : "2022-06-13T20:49:57.388575", //tempo de entrada no servidor
        "end"     : "2022-06-13T20:49:57.928327", //tempo de saída do servidor
        "response": 540                           //tempo de resposta do servidor
    }
}

Como se pode observar, a resposta, por dentro do modelo padrão mostrado acima, dependerá da situação do servidor.

Quando a operação for executado com sucesso, sempre se resultará em código HTTP 200. Isso significa que, o "response" será uma valor válido com a resposta da operação executada, sendo o valor uma Array, um JSON, uma string, um número ou um booleano.

Caso durante a operação ocorrer uma falha, se resultará em código HTTP recorrente aquela falha com o seu estado definido e sua descrição introduzindo o erro ocorrido.

Importante ressaltar que durante toda utilização da API, se necessita a utilização de medidas estratégicas de segurança e privacidade dos fluxos de dados. Para saber mais, clique aqui.