Name: Backend
Owner: Droids On Roids
Description: null
Created: 2016-03-12 02:40:47.0
Updated: 2016-03-15 08:26:03.0
Pushed: 2017-04-11 07:40:09.0
Homepage: null
Size: 546
Language: PHP
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
To bardzo proste API zawiera 3 podstawowe funkcje: upload image, get images i remove image.
URL:
s://snappyapp.herokuapp.com
Tutaj uploadujemy obrazek na serwer. Je?li podamy parametr to_userId, to wy?lemy obrazek tylko do konkretnego u?ytkownika. Je?li nie podamy, to obrazek otrzymaj? wszyscy.
Typ: POST
URL: https://snappyapp.herokuapp.com/images/upload
Parametry (w ciele zapytania):
file - (Obowi?zkowy) Obrazek, który wrzucamy,from_userId - (Obowi?zkowy) ID u?ytkownika, który wys?a? dany obrazek,to_userId - (Opcjonalny) ID u?ytkownika, do którego wysy?amy zdj?cie.W zale?no?ci od tego czy upload si? uda?, wyst?pi albo success, albo error. Odpowied? success:
uccess": "Image uploaded correctly."
Odpowied? error (przyk?adowa, kiedy nie podamy parametru from_userId):
rror": "You didn't specify parameter from_userId."
Dostajemy list? obrazków wrzuconych dla danego u?ytkownika. Je?li nie podamy parametru to_userId w URL, to dostaniemy obrazki tylko te, które by?y wrzucane do wszystkich.
Typ: GET
URL: https://snappyapp.herokuapp.com/images/get/{to_userId}
Parametry:
to_userId - (Opcjonalny) To jedyny parametr, który znajduje si? w URL a nie w ciele zapytania. Nale?y go do??czy? jak w przyk?adzie na dole.Przyk?ady URL:
s://snappyapp.herokuapp.com/images/get // images that were sent to all users
s://snappyapp.herokuapp.com/images/get/11 // images for user with id 11
W odpowiedzi znajduje si? tablica o nazwie images, która trzyma wszystkie obrazki dla wykonanego requestu. Jeden obrazek jest obiektem, który posiada:
url - Jest to pe?ny URL do obrazka,file_name - Nazwa pliku, która jest potrzebna do wywo?ania zapytania usuni?cia obrazka,from_userId - ID u?ytkownika, który wys?a? ten obrazek,to - Tutaj w zale?no?ci od tego, czy obrazek zosta? wys?any do konkretnego u?ytkownika czy do wszystkich, b?dzie albo ID u?ytkownika, albo 0, które oznacza, ?e zdj?cie zosta?o wys?ane do wszystkich,date - Data kiedy obrazek zosta? przes?any (a w zasadzie zapisany na serwerze).Przyk?ad odpowiedzi:
mages": [
{
"url": "https://snappyapp.herokuapp.com/images/all/1_2016.03.15_13.35.43_a5ebcb05b8233c8ada8425689055d29564f47bf6.jpg",
"file_name": "1_2016.03.15_13.35.43_a5ebcb05b8233c8ada8425689055d29564f47bf6.jpg",
"from_userId": "1",
"to": 0,
"date": "2016-03-15 13:35:43"
}
Tutaj mo?emy usun?? obrazek na podstawie nazwy obrazka oraz u?ytkownika, do którego dany obrazek zosta? wys?any.
Typ: POST
URL: https://snappyapp.herokuapp.com/images/remove
Parametry:
file_name - (Obowi?zkowy) Obowi?zkowy parametr,to_userId - (Opcjonalny) Je?eli podamy tu ID wi?ksze od 0, to oznacza to, ?e chcemy usun?? obrazek dla danego u?ytkownika (o ID to_userId o danej nazwie (file_name).W zale?no?ci od tego czy upload si? uda?, wyst?pi albo success, albo error. Odpowied? success:
uccess": "Image removed correctly"
Odpowied? error (przyk?adowa, kiedy nie znajdzie nam takiego obrazka dla podanych parametrów):
rror": "There is no file with given name for given user."