pre-requisites

• Authentication

Overview

Authentication provides who the requesting user is, while Authorization provides what the requesting user has access to. Authorization is required in order to use any of the external APIs. The authorization endpoint provides the API user with the partners and advertisers they have access to within ui.marketing. The authorized partners will have an authorizationId associated with it that can be retrieved from the API response. This authorizationId will be needed for all other external APIsGet all authorizations the authenticated user has access to.

Endpoint

Example

...

Request:

• Status: 200 OK

GET https://api.adcellerant.com/authorization

Example Response:

• Status: 200 OK

"authorizations": [
  {
    "name": "The Best Partner",
    "authorizationId": "891bb822-2d25-4128-8994-001c1b0044a3",
    "advertisers": [
      {
        "id": 456,
        "name": "Advertiser 1"
      },
      {
        "id": 789,
        "name": "Advertiser 2"
      },
      {
        "id": 123,
        "name": "Advertiser 3"
      }
    ]
  }
]

Header Specifications

• See: Authentication

Input Specifications

• N/A

Output Specifications

• A list of authorizations

...

Field

...

Description

...

name

...

the name of the authorization

...

authorizationId

...

the id of the authorization

...

advertisers

...

the list of authorized advertisers

• Fields on an Advertiser

...

Field

...

Description

...

id

...

the id of the advertiser

...

name

...

the name of the advertiser

Example Request:

• https://api.adcellerant.com/authorization

  • see: Authorization Response