This application connects to a fictional social media network. One endpoint registers a token and the other endpoint fetches posts made by fictional users across a 6 month period.
You should be running PHP 8.0+, the latest version of composer and available to use command line on your machine for any commands listed below. How you run PHP is up to you!
guzzlehttp/guzzle- to make API callssymfony/cache- not to disturb the API muchvlucas/phpdotenv- to keep some config data out of files
1. Run composer install:
To set up the dependencies run composer install the within project's root directory.
2. Run application:
To run the app: :composer serve
Application can be reached from the localhost: http://localhost:7777 - shows the main page.
Run tests:
Run php ./vendor/bin/phpunit
This application is using two custom API endpoints
POST: https://api.supermetrics.com/assignment/register
This endpoint registers a token for use against the second endpoint
PARAMS:
client_id: ju16a6m81mhid5ue1z3v2g0uh
email: [email protected]
name: Your Name
RETURNS:
sl_token: This token string should be used in the subsequent query. Please note that this token will only last 1 hour from when the REGISTER call happens. You will need to register and fetch a new token as you need it.
client_id: returned for informational purposes only
email: returned for informational purposes only
GET: https://api.supermetrics.com/assignment/posts
This endpoint fetches posts along a number of pages using the registered token.
PARAMS:
sl_token: Token from the register call
page: integer page number of posts (1-10)
RETURNS:
page: What page was requested or retrieved
posts: 100 posts per page