https://github.com/eperedo/platzi-api
unofficial platzi api
https://github.com/eperedo/platzi-api
Last synced: about 2 months ago
JSON representation
unofficial platzi api
- Host: GitHub
- URL: https://github.com/eperedo/platzi-api
- Owner: eperedo
- License: mit
- Created: 2019-02-13T14:37:37.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-02-14T05:12:45.000Z (over 6 years ago)
- Last Synced: 2025-02-07T23:27:16.588Z (4 months ago)
- Language: JavaScript
- Homepage: https://platzi-match.herokuapp.com/
- Size: 87.9 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Platzi Rest API
> the best and most unofficial Platzi REST API
### Documentation
Right now the API only has two endpoints.
### Profile [/profile/{username}]
```bash
# GET https://platzi-match.herokuapp.com/profile/eperedo
# Status: 200
```
It will return the following information
| Property Name | Description |
| ------------------ | ------------------------------------------------------------------------------------- |
| avatar | The image url that the user uploaded in their profile page |
| bio | The bio of the user |
| careers | Array of career Object |
| career[].name | The name of the career |
| career[].badge | The badge of the career |
| country | country of the user. It depends on the privacy settings of the user |
| courses | Array of course Object |
| course[].badge | The badge of the course |
| courses[].title | The title of the course |
| courses[].career | Career where the course belongs. |
| facebook | facebook url profile page of the user. It depends on the privacy settings of the user |
| flagUrl | the image url of the country user. It depends on the privacy settings of the user |
| platziLive | The url of the platzi live show if it is happening |
| name | The name of the user. it depends on the privacy settings of the user |
| oldCourses | Array of course Object |
| oldCourses[].badge | The bad of the course |
| oldCourses[].title | The title of the course |
| totalPoints | The total of points earned by the user |
| totalQuestions | The total of questions made by the user |
| totalAnswers | The total of answers made by the user |
| twitter | twitter url profile page of the user |
| website | website url of the user |
If the username does not exists you will receive a 404 HTTP status (NOT FOUND)
```bash
# GET https://platzi-match.herokuapp.com/profile/a_not_real_username
# Status: 404
```
if the username has a private profile you will receive a 403 HTTP status (Forbidden)
```bash
# GET https://platzi-match.herokuapp.com/profile/Acosticarito
# Status: 403
```
**⚠️ IMPORTANT️ ⚠️ : I am using Acosticarito username since it was the first one who show in the forums page and happy coincidence she has a private profile. Please do not try to contact her outside platzi, do not be the weird and creepy guy. If you are Acosticarito and you do not want to be expose in here please open an issue in this repo and I will remove inmediately**
### Profile [/profiles/{username}/{username2}/matches]
```bash
# GET https://platzi-match.herokuapp.com/profiles/eperedo/alex_rope/matches
# Status: 200
```
| Property Name | Description |
| ------------- | ---------------------------------------------------------- |
| match | The percentage match between 2 platzi users |
| totalMatches | Total of careers and courses who both users have in common |
| totalCareers | Total of careers both users have approved in platzi |
If the API can have enought information about the two users it will return a 400 status code, probably because
either the user does not exist or have a private profile.
```bash
# GET https://platzi-match.herokuapp.com/profiles/invalid_user/private_user/matches
# Status: 400
```
### Development
You will need node 8.x.x and google chrome installed in your computer.
1. Install dependencies
```bash
npm i # shortcut for npm install
```
2. Create a .env file with the following variables
```bash
# In mac I normally use /Applications/Google Chrome.app/Contents/MacOS/Google Chrome
CHROME_PATH=PATH_WHERE_YOU_HAS_CHROME_INSTALLED
CHROME_HEADLESS=true
# use false if you want to google chrome open right on your face!
```
3. Run webserver
```
npm start
```
4. Testing
We are using [jest](https://jestjs.io) because it's kinda awesome.
```bash
npm t # shortcut for npm test
```