An easy-to-use REST API, available via HTTP/HTTPS protocols GET, POST, PUT or DELETE. The requests can be used to grab site's data in simple JSON format including most of the core items.
This APIs uses OAuth 2.0 for authentication. Consult the official OAuth2.0 documentation for the down-and-dirty technical specifications.
All resource requests (APIs Call) are requiring oauth2 authentication.
Grant Types allow to expose multiple ways for a client to receive an Access Token. Currently supported grant types:
Which requires the user to authenticate and redirects back to the client with an authorization code (Authorization Code grant type) or access token (Implicit grant type).
example.com/restful_api/authorize
Which uses the configured Grant Types to return an access token to the client.
example.com/restful_api/token
This project aims to create an easy-t-understand and well-tested framework for creating APIs. On this page, we will explain the basics of using phpFox RESTful API such as sending and receiving data, serializing data in HTTP requests, and more.
Call the authorize endpoint to get the code.
example.com/restful_api/authorize?response_type=code&client_id=CLIENT_ID
The request above will make an authorization form to user. If the user authorize this request, an authorized code will be returned to the client's redirect URI (set in client settings).
The authorization code can be used to receive an access token from the token endpoint.
$ curl -u CLIENT_ID:CLIENT_SECRET example.com/restful_api/token -d 'grant_type=authorization_code&code=AUTHORIZATION_CODE' |
You will receive an access token:
"access_token":"ACCESS_TOKEN","expires_in":86400,"token_type":"bearer","scope":"null":"REFRESH_TOKEN"
Setting the query string parameter response_type=token
in the authorize endpoint.
example.com/restful_api/authorize?response_type=token&client_id=CLIENT_ID&redirect_uri=app.example.com/callback
A successful token request will be returned in the fragment of the callback URI:
app.example.com/callback#access_token=EACCESS_TOKEN&expires_in=86400&token_type=bearer
Send the user credentials directly to receive an access token
$ curl -u CLIENT_ID:CLIENT_SECRET example.com/restful_api/token -d 'grant_type=password&username=USER_EMAIL&password=USER_PASSWORD' |
URI Parameters: username, password
Example using HTTP Basic Authentication:
$ curl -u CLIENT_ID:CLIENT_SECRET example.com/restful_api/token -d 'grant_type=client_credentials' |
A refresh token must be retrieved using the Authorization Code or User Credentials grant types. This refresh token can then be used to generate a new access token of equal or lesser scope.
$ curl -u CLIENT_ID:CLIENT_SECRET example.com/restful_api/token -d 'grant_type=refresh_token&refresh_token=REFRESH_TOKEN' |
To access resources, you must add access token to the URI Parameters or the header of request.
example.com/restful_api/blog?access_token=ACCESS_TOKEN
The response data is in JSON format. Read each API for more details.