Grabo Partners API  »  Въведение  »  Requests & Responses

Requests & Responses

API Requests

Всяка заявка към API-то се извършва по следния начин:

  • API URL: https://grabo.bg/api/partners/{api_node}/{function}
  • HTTP Method: GET
  • Базови параметри:
  • api_key задължителен Вашият API Key за достъп
    company_id задължителен ЕИК на фирмата Ви
    format незадължителен Желан формат на отговора - json или xml. Ако не посочите този параметър, резултатът ще бъде в json.
  • Други параметри: Всяка функция на всеки API Node изисква определени допълнителни параметри. Информация за тях можете да намерите в съответните секции.
  • Примерен Request URL:
    https://grabo.bg/api/partners/deals/list/?api_key=b7e357638c2e1dfb29b33cca136d0086&company_id=203412406&format=json

    API Responses

    Всеки отговор е обект със следната структура:
    success Boolean: True или False, в зависимост от това дали API заявката е успешна.
    error False при успешна API заявка или Object с повече информация при възникнала грешка (описание на грешките).
    result Object, съдържащ данните на отговора.
    Примерен JSON отговор:
    { "success": true, "error": false, "result": { "some_data_1": 123, "some_data_2": { "param1": "value1", "param2": "value2" } } }
    Примерен XML отговор:
    <?xml version="1.0"?> <response> <success>1</success> <error/> <result> <some_data_1>123</some_data_1> <some_data_2> <param1>value1</param1> <param2>value2</param2> </some_data_2> </result> </response>

    В настоящата документация всички примерни отговори са в JSON формат.

    Каква е следващата стъпка

    Разгледайте секциите deals, vouchers и profiles.