This library makes it stupidly simple to integrate your application with OAuth 2.0 identity providers. It has built in support for:
- Github
- Microsoft
- Vkontakte
- Kompas
Adding support for other providers is trivial.
The library requires PHP 5.3+ and is PSR-0 compatible.
First, you must install composer in your project.
Create a composer.json
file in your project root:
{
"require": {
"kompas/oauth2-client": "0.3"
}
}
Add this line to your application’s index.php
file:
require 'vendor/autoload.php';
// composer autoload
require_once "vendor/autoload.php";
$provider = new League\OAuth2\Client\Provider\Kompas(array(
'clientId' => 'XXXXXXXX',
'clientSecret' => 'XXXXXXXX',
'redirectUri' => ''
));
try {
// Try to get an access token (using the client credentials grant)
$t = $provider->getAccessToken('client_credentials');
try {
$provider->setFilterBySite('nasional,megapolitan');
$latest = $provider->getRssLatest($t);
$response['latestFiltered'] = json_decode($latest, true); // result filtered
$mostcommented = $provider->getRssMostCommented($t);
$response['mostCommentedFiltered'] = json_decode($mostcommented, true); // result filtered
$provider->setFilterBySite(); // reset filtered
$mostpopular = $provider->getRssMostPopular($t);
$response['mostPopularNonFiltered'] = json_decode($mostpopular, true); // result not filtered
} catch (Exception $e) {
// Failed to get Rss
$response = array(
'status' => false,
'error' => $e->getMessage()
);
}
} catch (Exception $e) {
// Failed to get access token
$response = array(
'status' => false,
'error' => $e->getMessage()
);
}
header("Content-Type: application/json");
echo json_encode($response);
Available Feature:
getRssLatest(token, service, siteno, sectionid)
getRssMostCommented(token, service, siteno, sectionid)
getRssMostPopular(token, service, siteno, sectionid)
setFilterBySite(sites)
*only in json
format
Example:
$all_latest = $provider->getRssLatest(AccessToken);
$provider->setFilterBySite('nasional,megapolitan'); // (,) delimiter
$filter_latest = $provider->getRssLatest(AccessToken);
$provider->setFilterBySite(); // reset filter
$news_latest = $provider->getRssLatest(AccessToken, 'kompascom', 1, 1);
Authorization:
Request body
-
HTTP request
POST http://apis.kompas.com/oauth2/token
-
Parameters Require body parameters
- client_id [Your registered client id]
- client_secret [Your registered client secret]
- grant_type [MUST value "client_credentials"]
-
Example
POST /oauth2/token HTTP/1.1 Host: apis.kompas.com Cache-Control: no-cache Content-Type: application/x-www-form-urlencoded client_id=xxx&client_secret=xxx&grant_type=client_credentials
-
Response
{
"access_token": "xxx",
"token_type": "bearer",
"expires": 1387445831,
"expires_in": 3600
}
Requires authorization
Request body
-
HTTP request
GET http://apis.kompas.com/rss/kompascom/latest
-
Parameters Require query parameters
- access_token [MUST value access token from authorization response]
Optional path parameters
- siteId [integer]
- sectionId [integer]
Optional query parameters
- filterBySite [string, delimeter with comma. ex: nasional,megapolitan]
-
Example all latests
GET /rss/kompascom/latest?access_token=xxx HTTP/1.1 Host: apis.kompas.com Cache-Control: no-cache Content-Type: application/x-www-form-urlencoded
-
Example latest with filter sites
GET /rss/kompascom/latest?access_token=xxx&filterBySite=nasional,megapolitan HTTP/1.1 Host: apis.kompas.com Cache-Control: no-cache Content-Type: application/x-www-form-urlencoded
-
Example latest for specific site
GET /rss/kompascom/latest/1?access_token=xxx HTTP/1.1 Host: apis.kompas.com Cache-Control: no-cache Content-Type: application/x-www-form-urlencoded
-
Example latest for specific section site
GET /rss/kompascom/latest/1/1?access_token=xxx HTTP/1.1 Host: apis.kompas.com Cache-Control: no-cache Content-Type: application/x-www-form-urlencoded
-
Response
[
{
uid: "2013.12.13.0711189",
channel: {
site: "bola",
section: ""
},
title: "Awal Januari, Trofi Piala Dunia Tiba di Indonesia",
description: "Coca-Cola sebagai official sponsor of the FIFA World Cup™ ...",
media: {
image: {
thumb: "http://assets.kompas.com/data/photo/2013/12/13/1458220455320155t.jpg",
content: "http://assets.kompas.com/data/photo/2013/12/13/1458220455320155780x390.jpg"
}
},
url: {
permalink: "http://bola.kompas.com/read/2013/12/13/0711189/Awal.Januari.Trofi.Piala.Dunia.Tiba.di.Indonesia"
},
service: "kompascom",
published_date: "2013-12-13 07:11:18"
},
...
]
Requires authorization
Request body
-
HTTP request
GET http://apis.kompas.com/rss/kompascom/mostcommented
-
Parameters Require query parameters
- access_token [MUST value access token from authorization response]
Optional path parameters
- siteId [integer]
- sectionId [integer]
Optional query parameters
- filterBySite [string, delimeter with comma. ex: nasional,megapolitan]
-
Example all of most commented
GET /rss/kompascom/mostcommented?access_token=xxx HTTP/1.1 Host: apis.kompas.com Cache-Control: no-cache Content-Type: application/x-www-form-urlencoded
-
Example most commented with filter sites
GET /rss/kompascom/mostcommented?access_token=xxx&filterBySite=nasional,megapolitan HTTP/1.1 Host: apis.kompas.com Cache-Control: no-cache Content-Type: application/x-www-form-urlencoded
-
Example most commented for specific site
GET /rss/kompascom/mostcommented/1?access_token=xxx HTTP/1.1 Host: apis.kompas.com Cache-Control: no-cache Content-Type: application/x-www-form-urlencoded
-
Example most commented for specific section site
GET /rss/kompascom/mostcommented/1/1?access_token=xxx HTTP/1.1 Host: apis.kompas.com Cache-Control: no-cache Content-Type: application/x-www-form-urlencoded
-
Response
[
{
uid: "2013.12.13.0711189",
channel: {
site: "bola",
section: ""
},
title: "Awal Januari, Trofi Piala Dunia Tiba di Indonesia",
description: "Coca-Cola sebagai official sponsor of the FIFA World Cup™ ...",
media: {
image: {
thumb: "http://assets.kompas.com/data/photo/2013/12/13/1458220455320155t.jpg",
content: "http://assets.kompas.com/data/photo/2013/12/13/1458220455320155780x390.jpg"
}
},
url: {
permalink: "http://bola.kompas.com/read/2013/12/13/0711189/Awal.Januari.Trofi.Piala.Dunia.Tiba.di.Indonesia"
},
service: "kompascom",
published_date: "2013-12-13 07:11:18",
statistics: {
comment_count: 279
}
},
...
]
Requires authorization
Request body
-
HTTP request
GET http://apis.kompas.com/rss/kompascom/mostpopular
-
Parameters Require query parameters
- access_token [MUST value access token from authorization response]
Optional path parameters
- siteId [integer]
- sectionId [integer]
Optional query parameters
- filterBySite [string, delimeter with comma. ex: nasional,megapolitan]
-
Example all of most popular
GET /rss/kompascom/mostpopular?access_token=xxx HTTP/1.1 Host: apis.kompas.com Cache-Control: no-cache Content-Type: application/x-www-form-urlencoded
-
Example most popular with filter sites
GET /rss/kompascom/mostpopular?access_token=xxx&filterBySite=nasional,megapolitan HTTP/1.1 Host: apis.kompas.com Cache-Control: no-cache Content-Type: application/x-www-form-urlencoded
-
Example most popular for specific site
GET /rss/kompascom/mostpopular/1?access_token=xxx HTTP/1.1 Host: apis.kompas.com Cache-Control: no-cache Content-Type: application/x-www-form-urlencoded
-
Example most popular for specific section site
GET /rss/kompascom/mostpopular/1/1?access_token=xxx HTTP/1.1 Host: apis.kompas.com Cache-Control: no-cache Content-Type: application/x-www-form-urlencoded
-
Response
[
{
uid: "2013.12.13.0711189",
channel: {
site: "bola",
section: ""
},
title: "Awal Januari, Trofi Piala Dunia Tiba di Indonesia",
description: "Coca-Cola sebagai official sponsor of the FIFA World Cup™ ...",
media: {
image: {
thumb: "http://assets.kompas.com/data/photo/2013/12/13/1458220455320155t.jpg",
content: "http://assets.kompas.com/data/photo/2013/12/13/1458220455320155780x390.jpg"
}
},
url: {
permalink: "http://bola.kompas.com/read/2013/12/13/0711189/Awal.Januari.Trofi.Piala.Dunia.Tiba.di.Indonesia"
},
service: "kompascom",
published_date: "2013-12-13 07:11:18",
statistics: {
read_count: 279
}
},
...
]
The MIT License (MIT). Please see License File for more information.