Documentation

API Version 1.1

This documentation explains how to register, configure, and develop your app so you can successfully use our APIs

Create App

In order for your app to access our APIs, you must register your app using the App Dashboard. Registration creates an App ID that lets us know who you are, helps us distinguish your app from other apps.

  1. You will need to create a new App Create New App
  2. Once you created your App you will get your app_id and app_secret
OAuth Login With System

The OAuth Login With System is a fast and convenient way for people to create accounts and log into your app. Our Login With system enables two scenarios: authentication and asking for permissions to access people's data. You can use Login With system simply for authentication or for both authentication and data access.

  1. Starting the OAuth login process, You need to use a link for your app like this:
    <a href="https://cedhhub.com/community/api/oauth?app_id=YOUR_APP_ID">Log in With cEDH Hub | The Official Social Media Platform for cEDH</a>

    The user will be redirected to the Login With page like this:

  2. Once the user has accepted your app, the user will be redirected to your App Redirect URL with the auth_key like this:
    https://mydomain.com/my_redirect_url.php?auth_key=AUTH_KEY
    This auth_key is valid for one time login usage. Once it has been used, it cannot be used again. and you will have to generate new code as well as redirect the user to the log in with link again.
Access Token

Once you get the user approval of your app Log in With window and returned with the auth_key , you are now ready to retrive data from our APIs. To start this process you will need to authorize your app and get the access_token . You can follow the steps below to learn how to get it.

  1. To get an access token, make an HTTP GET request to the following endpoint like this:
                <?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://cedhhub.com/community/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
                }
                ?>                                                                                                
                                
    This access_token is only valid for 1 hour. Once it becomes invalidated, if needed, you will need to generate new token by having the user log in with link again..
APIs

Once you get your access_token Now you can retrieve informations from our system via HTTP GET requests which supports the following parameters

Endpoint Description
api/get_user_info

get user info

You can retrive user info like this

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

The result will be:

            {
              "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": ""
              }
            }