Documentação

Versão da API 1.1

Esta documentação explica como registar, configurar e desenvolver a sua aplicação para que possa usar com sucesso as nossas APIs

Criar Aplicação

Para que a sua aplicação aceda às nossas APIs, deve registar a sua aplicação usando o Painel da Aplicação. O registo cria um ID de Aplicação que nos permite saber quem é, ajudando-nos a distinguir a sua aplicação de outras.

  1. Precisará de criar uma nova Aplicação Criar Nova Aplicação
  2. Assim que criar a sua Aplicação, obterá o seu app_id e app_secret
Iniciar Sessão Com

O sistema Iniciar Sessão Com é uma forma rápida e conveniente para as pessoas criarem contas e iniciarem sessão na sua aplicação. O nosso sistema Iniciar Sessão Com permite dois cenários: autenticação e pedido de permissões para aceder aos dados das pessoas. Pode usar o sistema Login Com simplesmente para autenticação ou para autenticação e acesso a dados.

  1. Ao iniciar o processo de login OAuth, precisa de usar um link para a sua aplicação como este:
    <a href="https://www.ngolabiz.it.ao/api/oauth?app_id=YOUR_APP_ID">Log in With Ngolabiz</a>

    O utilizador será redirecionado para a página Iniciar Sessão Com como esta

  2. Assim que o utilizador aceitar a sua aplicação, será redirecionado para o URL de Redirecionamento da sua Aplicação com auth_key assim:
    https://mydomain.com/my_redirect_url.php?auth_key=AUTH_KEY
    Isto auth_key válido apenas para uso único, por isso, depois de o usar, não poderá usá-lo novamente. Para gerar um novo código, precisará de redirecionar o utilizador para o link de iniciar sessão com novamente.
Token de Acesso

Assim que obtiver a aprovação do utilizador na janela Iniciar Sessão Com da sua aplicação e retornar com o auth_key o que significa que agora está pronto para obter dados das nossas APIs e, para iniciar este processo, precisará de autorizar a sua aplicação e obter o access_token e pode seguir os nossos passos para aprender como obtê-lo.

  1. Para obter um token de acesso, faça um pedido HTTP GET ao seguinte endpoint como este:
    <?php
    
    $app_id = "YOUR_APP_ID"; // your app id
    $app_secret = "YOUR_APP_SECRET"; // your app secret
    $auth_key = $_GET['auth_key']; // the returned auth key from previous step
    
    // Prepare the POST data
    $postData = [
      'app_id' => $app_id,
      'app_secret' => $app_secret,
      'auth_key' => $auth_key
    ];
    
    // Initialize cURL
    $ch = curl_init('https://www.ngolabiz.it.ao/api/authorize');
    
    // Set cURL options for POST
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($postData));
    
    // Execute request
    $response = curl_exec($ch);
    
    // Check for cURL errors
    if (curl_errno($ch)) {
      die('cURL error: ' . curl_error($ch));
    }
    
    curl_close($ch);
    
    // Decode the JSON response
    $json = json_decode($response, true);
    
    // Use the access token if available
    if (!empty($json['access_token'])) {
      $access_token = $json['access_token']; // your access token
    }
    ?>
    
    Isto access_token válido apenas por 1 hora, por isso, quando ficar inválido, precisará de gerar um novo redirecionando o utilizador para o link de iniciar sessão com novamente.
APIs

Assim que obtiver o seu access_token Agora pode obter informações do nosso sistema através de pedidos HTTP GET que suportam os seguintes parâmetros

Endpoint Descrição
api/get_user_info obter informação do utilizador

Pode obter informação do utilizador assim

            if(!empty($json['access_token'])) {
                $access_token = $json['access_token']; // your access token
                $get = file_get_contents("https://www.ngolabiz.it.ao/api/get_user_info?access_token=$access_token");
            }
				

O resultado será:

            {
              "user_info": {
              "user_id": "",
              "user_name": "",
              "user_email": "",
              "user_firstname": "",
              "user_lastname": "",
              "user_gender": "",
              "user_birthdate": "",
              "user_picture": "",
              "user_cover": "",
              "user_registered": "",
              "user_verified": "",
              "user_relationship": "",
              "user_biography": "",
              "user_website": ""
              }
            }
				
Ngolabiz https://www.ngolabiz.it.ao