Dokumentacja API FaniMani.pl / wersja 0.2 / 20.07.2016 / strona  z

Dokumentacja API FaniMani.pl

Jakie możliwości daje API?

Obecna wersja API umożliwia dodawanie oraz edytowanie projektów i podopiecznych.

Autentykacja

Do korzystania z niektórych zasobów API wymagana jest autentykacja za pomocą tokena API, który uzyskać można kontaktując się z nami. Otrzymany token poprzedzony napisem Token i spacją należy umieścić w nagłówku Authentication zapytania HTTP tak jak na poniższym przykładzie:

curl -X GET https://fanimani.pl/api/v2/zasob-wymajagajacy-autentykacji/ -H 'Authorization: Token 7756bf1e2f31ef96d0d770775b06812a213f26b0'

Aby uzyskać klucz API proszę wysłać wiadomość z adresu email administratora organizacji na adres admin@fanimani.pl

Podopieczni

Zasób: /organizations/<org_id>/pupils/ 

Obsługiwane są poniższe pola:

Nazwa pola

Typ

Wymag

Tylko odczyt

Domyślna wartość

id

int

external_id

str

parent

obj

type

str

name

str

name_genitive

str

slug

str

na podstawie pola `name`

description

str

krs

str

photos

obj

website_url

str

facebook_fanpage_url

str

video_url

str

visible

bool

true

verified

bool

true

order

int

url

str

support_target_1

str

support_target_2

str

support_target_3

str

Lista podopiecznych organizacji

GET /organizations/<org_id>/pupils/ 

Dodanie podopiecznego

POST /organizations/<org_id>/pupils/ 

Modyfikacja podopiecznego

PATCH /organizations/<org_id>/pupils/<pupil_id>/ 

W zapytaniu należy umieścić tylko te pola, które mają być zmodyfikowane.

Usunięcie podopiecznego

DELETE /organizations/<org_id>/pupils/<pupil_id>/ 

Informacje o darowiznach podopiecznego

GET /organizations/<org_id>/pupils/<pupil_id>/revenue-info/ 

Odpowiedź będzie miała kształt:

{

    "amount_waiting": 0,

    "amount_confirmed": 0,

    "amount_ready": 5.34,

    "amount_not_rejected": 5.34,

    "amount_total": 5.34,

    "revenues": [

        {

            "name": "Zalando PL",

            "amount": 5.34,

            "transaction_date": "2015-11-30T13:31:27.737000",

            "status_updated_date": "2016-01-30T05:04:41.432284",

            "status": "withdrawn",

            "network_status": "ready"

        },

        ...

    ]

}

Zdjęcia beneficjenta
(organizacji, podopiecznego, projektu)

Zasób: /beneficiaries/<id>/photos/ 
(gdzie <id> oznacza ID podopiecznego)

Obsługiwane są poniższe pola:

Nazwa pola

Typ

Wymag

Tylko odczyt

Domyślna wartość

id

int

photo_small

str

photo_large

str

photo

str

label

str

order

int

brak wartości ustawi zdj. jako ostatnie

Lista zdjęć beneficjenta

GET /beneficiaries/<id>/photos/ 

Dodanie zdjęcia do beneficjenta

POST /beneficiaries/<id>/photos/ 

Modyfikacja zdjęcia beneficjenta

PATCH /beneficiaries/<id>/photos/<photo_id>/ 

W zapytaniu należy umieścić tylko te pola, które mają być zmodyfikowane.

Usunięcie zdjęcia beneficjenta

DELETE /beneficiaries/<id>/photos/<photo_id>/