Publisher Entity API

Publisher Entity API

This API allows managing publishers via HTTP REST API calls methodology.

1. Login

In order to log in - the general login API is using. Example - Reporting API | Login API


2. Logout

In order to log out - the general logout API is using. Example - Reporting API | Logout API


3. Publisher entity API

3.1. Publishers List

Retrieves a list of all publishers in the logged network.

Request URL:
http://manage.aniview.com/api/adserver/public-publisher?format=json

Request Method:
GET

Status Code:
200 OK


3.2. Get Publisher Info

Request URL:
http://manage.aniview.com/api/adserver/public-publisher/{$publisher_id}?format=json

Request Method:
GET

Status Code:
200 OK


3.3. Create Publisher

Request URL:
http://manage.aniview.com/api/adserver/public-publisher?format=json

Request Method:
POST

Request payload:
JSON object of params described in section 3.6

Notes:

  • name is a required field;

  • accounting params are required, but in case if they are not passed (accounting object is not set in request JSON) they will be set to default values;

  • status cannot be set during the creation of the object and will automatically set to active ;

  • internal and autogenerated fields cannot be set.

Status Code:
200 OK


3.4. Edit Publisher

Request URL:
http://manage.aniview.com/api/adserver/public-publisher/{$publisher_id}?format=json

Request Method:
PUT

Request payload:
JSON object of params described in section 3.6

Notes:

  • to remove some unrequired value - set it to null

  • internal and autogenerated fields cannot be updated manually.

Status Code:
200 OK


3.5. Archive Publisher

Request URL:
http://manage.aniview.com/api/adserver/public-publisher/{$publisher_id}?format=json

Request Method:
DELETE

Status Code:
200 OK


3.6 Publisher Object Structure

Attribute

Type

Description

Attribute

Type

Description

id

string

Unique identifier (internal)

name

string

Name of the publisher

email

string

Email of the publsher

description

string

Informative

status

int

The publisher’s status:
1 - active;
2 - deleted;

createdAt

int

Unix timestamp (autogenerated)

updatedAt

int

Unix timestamp (autogenerated)

channelPublisher

string

ID of an associated channelPublisher (APP/Site) instance

seller

object

Seller JSON params

accounting

object

Accounting params

3.6.1 Seller Object Structure

Attribute

Type

Description

Attribute

Type

Description

id

string

ID of the seller

name

string

Name of the seller

domain

string

Domain of the seller

type

string

The seller’s type
Allowed values:
BOTH , PUBLISHER ,INTERMEDIARY

3.6.2 Accounting Object Structure

Attribute

Type

Description

Attribute

Type

Description

type

int

The accounting type:
0 - revenue share;
1 - fixed cpm (fee)

fee

int|float

Fixed CPM

revShare

int|float

Revenue share