Access

Account registration in Adfox
API access for different types of users
Access rights for API assistants

To access the API, you need an Adfox account or a Yandex account that's linked to an Adfox account. Authorization takes place at every request: you need to pass the OAuth token that's generated for the Yandex account.

Account registration in Adfox

To register an account with Adfox, you need a Yandex account. These accounts will be linked. After registration, you'll get access to the Adfox API and the Adfox and Yandex Advertising Network web interfaces.

I have a Yandex account

Note

We recommend choosing an account that you don't use for working with other Yandex services (like Yandex Direct or Yandex Market). Don't use your private account either because we'll be sending you documents and important notifications to this address.

I don't have a Yandex account

API access for different types of users

When you sign up for an Adfox account, you get administrator access. An account can only have one administrator.

The administrator has a full set of rights to manage advertising and account settings, both in the web interface and the API. The administrator can delegate some rights to other users by assigning them the following roles:

Assistant: Their ad management rights are specified by the administrator in the user settings. Doesn't have the permission to manage account settings.
API Assistant: The set of rights is specified by the account administrator. To learn more about rights and access to methods, see the table.
Advertiser: They can only receive reports on their own campaigns.
Site owner: In the API, they can only access the get a list of banners method.

Access rights for API assistants

Using API assistants, you can grant employees access to the Adfox API with a certain set of rights:

RO: Read-only. Get lists (actions: list, utility, info, listActiveBanners, and listValues) and get reports (the report action).
RW: Read/write. Add, modify, and delete objects. Modify settings for the account, sites, campaigns, and banners. No access to user management (advertiser, assistant, and webmaster).
RW + manage users: Full access to the account.

Only the account administrator can create and manage API assistants through the web interface.

Context (`object`)	Action (`action`)	Action object name (`actionObject`)	`RO`	`RW`	`RW + MU`
account
	`add`
		`advertiser`	-	-	+
		`assistant`	-	-	+
		`banner`	-	+	+
		`bannerType`	-	+	+
		`campaign`	-	+	+
		`category`	-	+	+
		`place`	-	+	+
		`position`	-	+	+
		`superCampaign`	-	+	+
		`tracingPoint`	-	+	+
		`webmaster`	-	-	+
		`website`	-	+	+
		`zone`	-	+	+
	`delete`
		`assistant`	-	-	+
		`banner`	-	+	+
		`bannerType`	-	+	+
		`campaign`	-	+	+
		`category`	-	+	+
		`place`	-	+	+
		`position`	-	+	+
		`superCampaign`	-	+	+
		`template`	-	+	+
		`tracingPoint`	-	+	+
		`user`	-	-	+
		`website`	-	+	+
		`zone`	-	+	+
	`list`		+	+	+
	`modify`		-	+	+
	`report`		+	+	+
	`changePassword`		-	-	+
	`auth`		+	+	+
	`utility`		+	+	+
advertiser
	`modify`		-	-	+
assistant
	`modify`		-	-	+
banner
	`info`		+	+	+
	`modify`		-	+	+
	`target`		-	+	+
bannerType
	`list`		+	+	+
	`modify`		-	+	+
	`updateDefaultBanner`		-	+	+
campaign
	`additionalUsers`		-	+	+
	`clone`		-	+	+
	`info`		+	+	+
	`list`		+	+	+
	`modify`		-	+	+
	`placing`		-	+	+
	`target` (`targetPlace`, `targetWebsite`, `targetZone`)		-	+	+
	`upload`		-	+	+
placement
	`info`		+	+	+
position
	`modify`		-	+	+
place
	`info`		+	+	+
	`listActiveBanners`		+	+	+
	`modify`		-	+	+
	`updateDefaultBanner`		-	+	+
superCampaign
	`additionalUsers`		-	+	+
	`modify`		-	+	+
tracingPoint
	`getCode`		+	+	+
	`modify`		-	+	+
userCriteria
	`addValue`		-	+	+
	`listValues`		+	+	+
	`modify`		-	+	+
	`modifyValue`		-	+	+
	`removeValue`		-	+	+
webmaster
	`info`		+	+	+
	`modify`		-	-	+
website
	`modify`		-	+	+
zone
	`modify`		-	+	+

Access

Account registration in AdfoxAccount registration in Adfox

API access for different types of usersAPI access for different types of users

Access rights for API assistantsAccess rights for API assistants

Was the article helpful?

Account registration in Adfox

API access for different types of users

Access rights for API assistants