Specyfikacja Techniczna

Nazewnictwo

Pierwsza litera przestrzeni nazw z małej, jeżeli więcej wyrazów w nazwie metody to każdy następny z dużej.
Metody z dużej litery każdy wyraz.

Założenia:

- Projekt wielojęzyczny ale gł. w języku angielskim
- Dodawanie nowych obiektów API przez zewnętrznych programistów
- Łatwe dodawanie nowych obiektów
- Biblioteki obsługi API dla większości popularnych języków
- Testy jednostkowe
- Możliwość tworzenia proxy i subsetów
- Izolowane środowisko uruchomieniowe


Obiekty:

/objects

/objects/objects

/objects/objects/products

/objects/persons

/objects/places

/objects/messages

/objects/messages/ads

/objects/image

/objects/movie

Przykładowe metody:

/text

Linkize(text) - zamienia URLe w tekście na linki

/graphics

Resize(image, width, height) - zmienia wielkość obrazka
Greyscale(image) - zmienia obrazek na odcienie szarości

/date

SecondsToHuman(seconds_count) - changes seconds to human readable form

/math

ObliczPoleTrojkata(dlugosc_boku_a, dlugosc_boku_b, dlugosc_boku_c)

/services

/services/payments

AddPoints(amount)
GetPoints(amount)
TransferPoints(user_source_id, user_target_id, amount)

/services/users

AddUser(name)
SetDefaultDeliveryAddress(user_id, place_id)

/services/places

AddPlace(country, city, street)

/services/commercial

Wydrukuj(plik_do_wydruku, place_id)
WydrukujNaKoszulce(plik_graficzny, rozmiar, place_id)
ZnajdzNajtanszyProdukt(nazwa_produktu)
OrderProduct(productId, place_id)

/services/commercial/classified_ads

AddAd(text)

/services/commercial/classified_ads/flats

AddFlatForSale(place, text, price, <more_options>)
AddFlatForRent(place, text, price, <more_options>)

/services/commercial/books

BuyABook(book_id)
BuyAEbook(book_id)

/services/internet

CheckIfWebsiteIsOnline(website_address)

/linguistics

/linguistics/textToSpeech

Powiedz(tekst_do_powiedzenia, lektor)

/linguistics/translations

Tlumacz(tekst, jezyk_docelowy)

/linguistics/polish

Dopelniacz(wyraz_w_mianowniku)
NumberToWord(number)

/general

Similarity(word1, word2)

/knowledge

AmerykanscyPrezydenci()

/knowledge/quotes

GetAuthors()
GetAuthorQuotes(ID)

/communication

/communication/sms

Send(tresc, numer)

/communication/mms

Send(tresc, zdjecie, numer)

/communication/email

Send(title, content, address, from)
Validate(address)

/communication/communicators

/communication/communicators/gadu-gadu

Send(content, address, login, password)

/communication/communicators/skype

Send(content, address, login, password)

/communication/microblogs

/communication/microblogs/twitter

Send(text, login, password)

/communication/microblogs/blip

Send(text, login, password)

/communication/microblogs/flaker

Send(text, login, password)

/communication/microblogs/sledzik

Send(text, login, password)

/communication/microblogs/pinger

Send(text, login, password)

/communication/microblogs/fejm

Send(text, login, password)

/communication/socialnetworks

/communication/socialnetworks/facebook

Send(text, login, password)

/communication/socialnetworks/grono

Send(text, login, password)

/communication/socialnetworks/myspace

Send(text, login, password)

/communication/blogs

/communication/blogs/blox

Send(text, login, password)

/communications/bogs/wordpress

Send(text, login, password)

O ile nie zaznaczono inaczej, treść tej strony objęta jest licencją Creative Commons Attribution-ShareAlike 3.0 License