Documentação

Versão da API 1.1

Esta documentação explica como registrar, configurar e desenvolver seu aplicativo para que você possa usar com sucesso nossas APIs

Criar App

Para que seu aplicativo acesse nossas APIs, você deve registrá-lo usando o Painel de aplicativos. O registro cria um ID do aplicativo que nos informa quem você é e nos ajuda a distinguir seu aplicativo de outros aplicativos.

  1. Você precisará criar um novo aplicativo Criar Novo App
  2. Depois de criar seu aplicativo, você receberá seu app_id e app_secret
Entrar com

O sistema Entrar é uma maneira rápida e conveniente para as pessoas criarem contas e fazerem login no seu aplicativo. Nosso sistema Log in With permite dois cenários, autenticação e solicitação de permissões para acessar dados de pessoas dados. Você pode usar o sistema Login With simplesmente para autenticação ou para ambos authentication and data access.

  1. Iniciando o processo de login do OAuth, você precisa usar um link para seu aplicativo como este:
    <a href="https://casaldisponivel.com/api/oauth?app_id=YOUR_APP_ID">Log in With CasalDisponível</a>

    O usuário será redirecionado para a página de Login com esta página

  2. Depois que o usuário aceitar seu aplicativo, ele será redirecionado para o URL de redirecionamento de aplicativo com auth_key curtiu isso:
    https://mydomain.com/my_redirect_url.php?auth_key=AUTH_KEY
    Esse auth_key válido apenas para uso único, portanto, uma vez usado, você não poderá usá-lo novamente e gerar um novo código, precisará redirecionar o usuário para o logon com o link novamente.
Token de Acesso

Depois de obter a aprovação do usuário do seu aplicativo, faça o login com a janela e retorne com o auth_key o que significa que agora você está pronto para recuperar dados de nossas APIs e para iniciar esse processo, precisará autorizar seu aplicativo e obter as access_token e você pode seguir nossos passos para aprender como obtê-lo.

  1. Para obter um token de acesso, faça uma solicitação HTTP GET para o seguinte terminal 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
    
                $get = file_get_contents("https://casaldisponivel.com/api/authorize?app_id=$app_id&app_secret=$app_secret&auth_key=$auth_key");
    
                $json = json_decode($get, true);
                if(!empty($json['access_token'])) {
                    $access_token = $json['access_token']; // your access token
                }
                ?>                                                                                                
                                
    Esse access_token válido apenas por apenas uma hora, portanto, uma vez inválido, será necessário criar um novo redirecionando o usuário para o login com o link novamente.
APIs

Depois de obter seu access_token Agora você pode recuperar informações do nosso sistema através de solicitações HTTP GET que suportam os seguintes parâmetros

Endpoint Descrição
api/get_user_info

obter informações do usuário

Você pode recuperar informações do usuário como esta

            if(!empty($json['access_token'])) {
                $access_token = $json['access_token']; // your access token
                $get = file_get_contents("https://casaldisponivel.com/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": ""
              }
            }