#316: Вспомогательная информация

Отредактирована: 11 дней назад

Типы площадок

Параметры

HTTP метод	Права доступа	URL	Параметры	Примечание
GET	public_data	https://api.admitad.com/ websites/kinds/	offset**	Возвращает виды площадок*
			limit**

* Возвращает результат в формате JSON

**Задаёт пропуск и количество возвращаемых записей. Например limit=5&offset=2

Пример использования

Пример запроса с использованием утилиты curl:

curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/websites/kinds/

Пример ответа API-сервера в формате JSON:

{  
    "results": [  
        "website",  
        "doorway",  
        "contextual",  
        "social_app",  
        "social_group"  
    ],  
    "_meta": {  
        "count": 7,  
        "limit": 5,  
        "offset": 0  
    }  
}

Регионы площадок

Параметры

HTTP метод	Права доступа	URL	Параметры	Примечаение
GET	public_data	https://api.admitad.com/websites/ regions/	offset**	Возвращает список регионов*
			limit**

* Возвращает результат в формате JSON

** Задаёт пропуск и количество возвращаемых записей. Например limit=5&offset=2

Пример использования

Пример запроса с использованием утилиты curl:

curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/websites/regions/

Пример ответа API-сервера в формате JSON:

{  
    "results": [  
        "RU",  
        "UA",  
        "BY"  
    ],  
    "_meta": {  
        "count": 20,  
        "limit": 3,  
        "offset": 0  
    }  
}

Дополнительные регионы

01 — СНГ
00 — Все

Категории партнерских программ

Параметры

HTTP метод	Права доступа	URL	Параметры	Примечание
GET	public_data	https://api.admitad.com/categories/	offset**	Возвращает список категорий партнерских программ*
			limit**
			campaign***
			language****
			order_by*****
GET	public_data	https://api.admitad.com/categories/ advcampaign/{id}/	offset**	Возвращает список категорий партнерской программы, где id — это идентификатор партнерской программы*
			limit**
			language***
			order_by*****
GET	public_data	https://api.admitad.com/categories/{id}/	language****	Возвращает категорию партнерской программы, где id — это идентификатор категории*

* Возвращает результат в формате JSON.

** Задаёт пропуск и количество возвращаемых записей. Например limit=5&offset=2

*** Фильтр по партнерским программам. Например campaign=3&campaign=4, где значения — это идентификаторы партнерских программ.

**** Язык ответа. Например language=de, где значения - это двухбуквенный код.

***** Порядок сортировки. Возможные значения:

: + name
Знак '-' перед значением означает обратный порядок. Например order_by=-name.

Пример использования

Пример запроса с использованием утилиты curl:

curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/categories/  

curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/categories/12/  
  
curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/categories/advcampaign/6/

Пример ответа API-сервера в формате JSON:

{  
    "results": [  
        {  
            "name": "Browser",  
            "language": "en",  
            "parent": {  
                "name": "Online Games",  
                "language": "en",  
                "parent": null,  
                "id": 2  
            },  
            "id": 3  
        },  
        {  
            "name": "Other",  
            "language": "en",  
            "parent": null,  
            "id": 5  
        },  
        {  
            "name": "Client",  
            "language": "en",  
            "parent": {  
                "name": "Online Games",  
                "language": "en",  
                "parent": null,  
                "id": 2  
            },  
            "id": 4  
        }  
    ],  
    "_meta": {  
        "count": 11,  
        "limit": 3,  
        "offset": 0  
    }  
}

Описание полей ответа API-сервера

Название	Описание
id	Category ID
name	Name of category
language	Response language
parent	The identifier of the parent category

Системные языки

Параметры

HTTP метод	Права доступа	URL	Параметры	Примечание
GET	public_data	https://api.admitad.com/languages/	offset** *	Возвращает список доступных языков*
			limit**
GET	public_data	https://api.admitad.com/ languages/{code}/		Возвращает язык, где code — это код языка(language_code)*

* Возвращает результат в формате JSON

** Задаёт пропуск и количество возвращаемых записей. Например limit=5&offset=2

Пример использования

Пример запроса с использованием утилиты curl:

curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/websites/languages/?limit=2

Пример ответа API-сервера в формате JSON:

{  
    "results": [  
        {  
            "flag": "http://admitad.com/media/images/flags/c8ef33a926799c7c3d7103212a78b187.png",  
            "language": "Русский",  
            "language_code": "ru"  
        },  
        {  
            "flag": "http://admitad.com/media/images/flags/a8ef33a926799c7c3d7122222a78b187.png",  
            "language": "Deutsch",  
            "language_code": "de"  
        }  
    ],  
    "_meta": {  
        "count": 2,  
        "limit": 2,  
        "offset": 0  
    }  
}

Описание полей ответа API-сервера

Название	Описание
flag	Изображение флага языка
languages	Название языка
language_code	Код языка

Системные валюты

Параметры

HTTP метод	Права доступа	URL	Параметры	Примечание
GET	public_data	https://api.admitad.com/currencies/	limit ** *	Возвращает список валют*
			offset **

* Возвращает результат в формате JSON

** Задаёт пропуск и количество возвращаемых записей. Например limit=5&offset=2

Пример использования

Пример запроса с использованием утилиты curl:

curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/currencies/

Пример ответа API-сервера в формате JSON:

{
    "results": [  
        {  
            "code": "EUR",  
            "min_sum": "20.00",  
            "name": "Euro",  
            "sign": "€"  
        },  
        {  
            "code": "RUB",  
            "min_sum": "750.00",  
            "name": "Russian ruble",  
            "sign": "руб."  
        },  
        {  
            "code": "USD",  
            "min_sum": "25.00",  
            "name": "American dollar",  
            "sign": "$"  
        }  
    ],  
    "_meta": {  
        "count": 3,  
        "limit": 20,  
        "offset": 0  
    }  
}

Описание полей ответа API-сервера

Название	Описание
code	Код валюты
name	Название валюты
sign	Символ валюты
min_sum	Минимальная сумма для вывода

Курсы валют

Параметры

HTTP метод	Права доступа	URL	Примечание
GET	public_data	https://api.admitad.com/ currencies/rate/	Возвращает курс для указанной валютной пары

Список GET-параметров для запроса

Название	Описание
base	Код валюты (Системные валюты), из которой нужно конвертировать
target	Код валюты (Системные валюты), в которую нужно конвертировать
date	Дата курса в формате dd.mm.YYYY

Все параметры являются обязательными
Коды валют должны быть представленны в соответствии с ISO 4217

Список полей ответа

Название	Описание
base	Код валюты (Системные валюты), из которой нужно конвертировать
target	Код валюты (Системные валюты), в которую нужно конвертировать
date	Дата курса
rate	Курс валюты (base * rate = target)

Коды валют должны быть представленны в соответствии с ISO 4217

Пример запроса с использованием утилиты curl:

curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/currencies/rate/?base=EUR&target=USD&date=24.06.2014

Пример ответа API-сервера в формате JSON:

{  
    "date": "2014-06-24",  
    "rate": "1.3600000000",  
    "base": "EUR",  
    "target": "USD"  
}

Виды трафика

Параметры

HTTP метод	Права доступа	URL	Параметры	Примечание
GET	public_data	https://api.admitad.com/traffic/	offset ** *	Возвращает доступные виды трафика*
			limit **

* Возвращает результат в формате JSON

** Задаёт пропуск и количество возвращаемых записей. Например limit=5&offset=2

Пример использования

Пример запроса с использованием утилиты curl:

curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/traffic/

Пример ответа API-сервера в формате JSON:

{  
    "results": [  
        {  
            "name": "Cashback",  
            "id": 1  
        },  
        {  
            "name": "PopUp / ClickUnder",  
            "id": 2  
        },  
        {  
            "name": "Doorway pages",  
            "id": 4  
        },  
        {  
            "name": "E-Mail-Marketing",  
            "id": 5  
        },  
        {  
            "name": "Brand-Bidding",  
            "id": 6  
        },  
        {  
            "name": "Social Media",  
            "id": 7  
        },  
        {  
            "name": "Toolbar",  
            "id": 9  
        },  
        {  
            "name": "Adult",  
            "id": 14  
        },  
        {  
            "name": "Banner-teaser networks",  
            "id": 18  
        },  
        {  
            "name": "YouTube Channel",  
            "id": 19  
        },  
        {  
            "name": "Брокерский трафик",  
            "id": 20  
        }  
    ],  
    "_meta": {  
        "count": 11,  
        "limit": 20,  
        "offset": 0  
    }  
}