Обзор

AdGuard DNS предоставляет REST API, который вы можете использовать в своих приложениях.

Аутентификация

Генерация токена доступа

Make a POST request for the following URL with the given params to generate the access_token:

https://api.adguard-dns.io/oapi/v1/oauth_token

Параметр	Описание
имя пользователя	Email
пароль	Пароль
mfa_token	Токен двухфакторной аутентификации (если включена в настройках аккаунта)

В ответ вы получите access_token и refresh_token.

• access_token истекает через несколько секунд (срок указан в параметре expires_in). Вы можете запросить новый access_token, используя refresh_token (См.: Генерация токена доступа через продлеваемый токен).

• refresh_token генерируется один раз и затем не изменяется. Чтобы отозвать refresh_token, см.: Отзыв продлеваемого токена.

Пример запроса

$ curl 'https://api.adguard-dns.io/oapi/v1/oauth_token' -i -X POST \
    -H 'Content-Type: application/x-www-form-urlencoded' \
    -d 'username=user%40adguard.com' \
    -d 'password=********' \
    -d 'mfa_token=727810'

Пример ответа

{
  "access_token": "jTFho_aymtN20pZR5RRSQAzd81I",
  "token_type": "bearer",
  "refresh_token": "H3SW6YFJ-tOPe0FQCM1Jd6VnMiA",
  "expires_in": 2620978
}

Генерация токена доступа через продлеваемый токен

Токены доступа имеют ограниченное время действия. Once it expires, your app will have to use the refresh token to request for a new access token.

Сделайте следующий POST-запрос с указанными параметрами, чтобы получить новый токен доступа:

https://api.adguard-dns.io/oapi/v1/oauth_token

Параметр	Описание
refresh_token	Продлеваемый токен, с помощью которого должен быть сгенерирован новый токен доступа.

Пример запроса

$ curl 'https://api.adguard-dns.io/oapi/v1/oauth_token' -i -X POST \
    -H 'Content-Type: application/x-www-form-urlencoded' \
    -d 'refresh_token=H3SW6YFJ-tOPe0FQCM1Jd6VnMiA'

Пример ответа

{
  "access_token": "xQnT7GYT6Ag--3oY_EcOOdXe-I0",
  "token_type": "bearer",
  "refresh_token": "H3SW6YFJ-tOPe0FQCM1Jd6VnMiA",
  "expires_in": 2627999
}

Отзыв продлеваемого токена

Чтобы сбросить продлеваемый токен, сделайте следующий POST-запрос с указанными параметрами:

https://api.adguard-dns.io/oapi/v1/revoke_token

Пример запроса

$ curl 'https://api.adguard-dns.com/oapi/v1/revoke_token' -i -X POST \
    -d 'token=H3SW6YFJ-tOPe0FQCM1Jd6VnMiA'

Параметр	Описание
refresh_token	Продлеваемый токен, который должен быть сброшен

Authorization endpoint

To access this endpoint, you need to contact us at devteam@adguard.com. Please describe the reason and use cases for this endpoint, as well as provide the redirect URI. Upon approval, you will receive a unique client identifier, which should be used for the client_id parameter.

The /oapi/v1/oauth_authorize endpoint is used to interact with the resource owner and get the authorization to access the protected resource.

The service redirects you to AdGuard to authenticate (if you are not already logged in) and then back to your application.

The request parameters of the /oapi/v1/oauth_authorize endpoint are:

Параметр	Описание
response_type	Tells the authorization server which grant to execute
client_id	The ID of the OAuth client that asks for authorization
redirect_uri	Contains a URL. A successful response from this endpoint results in a redirect to this URL
state	An opaque value used for security purposes. If this request parameter is set in the request, it is returned to the application as part of the redirect_uri
aid	Affiliate identifier

Например:

https://api.adguard-dns.io/oapi/v1/oauth_authorize?response_type=token&client_id=CLIENT_ID&redirect_uri=REDIRECT_URI&state=1jbmuc0m9WTr1T6dOO82

To inform the authorization server which grant type to use, the response_type request parameter is used as follows:

• For the Implicit grant, use response_type=token to include an access token.

A successful response is 302 Found, which triggers a redirect to redirect_uri (which is a request parameter). The response parameters are embedded in the fragment component (the part after #) of the redirect_uri parameter in the Location header.

Например:

HTTP/1.1 302 Found
Location: REDIRECT_URI#access_token=...&token_type=Bearer&expires_in=3600&state=1jbmuc0m9WTr1T6dOO82

Получение доступа к API

Once the access and the refresh tokens are generated, API calls can be made by passing the access token in the header.

• Имя заголовка должно быть Authorization
• Значение заголовка должно быть Bearer {access_token}

API

Руководство по API

Please see the methods reference here.

Спецификация OpenAPI

Спецификация OpenAPI доступна по адресу https://api.adguard-dns.io/static/swagger/openapi.json.

Вы можете использовать другие инструменты для просмотра списка доступных методов API. For instance, you can open this file in https://editor.swagger.io/.

Changelog

The complete AdGuard DNS API changelog is available on this page.

Обратная связь

If you would like this API to be extended with new methods, please email us to devteam@adguard.com and let us know what you would like to be added.