Home

CityGrid Advertising APIs

Skip to end of metadata
Go to start of metadata

Introduction

The CityGrid Authentication API allows applications to login and receive an access token for use in subsequent calls to other Advertising APIs.

Contents

Login Endpoint

The login endpoint allows applications to obtain an access token for API calls that require authentication. The token is obtained via HTTPS POST to:

api.citygrid.com/accounts/user/v2/login

Request Parameters

Parameter

Description

Required

Type

username

CityGrid username

Yes

String

password

CityGrid password

Yes

String

Request Headers

Header

Description

Required

Valid Values

Default

Accept

Requested format for the response

No

application/json
application/xml

application/json

Content-Type

Media type of the request body

Yes

application/x-www-form-urlencoded

 

developerToken

The token received during registration

Yes

Valid token

 

Request Examples

Example 1: Request an access token to be returned in a JSON response
Example 2: Request an access token to be returned in an XML response

Response Properties

Property

Type

Description

response

Response Metadata

(See complete response descriptions)

authToken

String

The token to pass in the header in subsequent API requests

Response Examples

Example 1: A JSON success response
Example 2: A JSON error response
Example 3: An XML success response
Example 4: An XML error response
  • No labels