Making Authenticated Requests

Accessing the Twitter Ads API endpoints requires your application to send authenticated web requests securely using TLS to https://ads-api.x.com.

The following sections will provide an overview of making authenticated API requests, setting up Twurl to interact with the API, and extending your application to support OAuth 1.0a and make requests against your Ads account.

Requirements

Before making authenticated requests to the Twitter Ads API, you will need:

Using the API

The Advertising API is accessed on https://ads-api.x.com. The standard REST API, and the Advertising API can be used together with the same client app. The Advertising API enforces HTTPS, therefore attempts to access an endpoint with HTTP will result in an error message.

The Ads API outputs JSON. All identifiers are strings and all strings are UTF-8. The Advertising API is versioned and the version is specified as the first path element of any resource URL.

https://ads-api.x.com/<version>/accounts

HTTP verbs & typical response codes

There are four HTTP verbs used in the Ads API:

  • GET retrieves data 
  • POST creates new data, such as campaigns
  • PUT updates existing data, like line items
  • DELETE removes data.

While deletions are permanent, deleted data can still be viewed from most GET-based methods by including an explicit with_deleted=true parameter when asking for the resource. Otherwise, deleted records will return a HTTP 404.

A successful request will return a HTTP 200-series response along with the JSON response representing the object when creating, deleting, or updating a resource.

When updating data with HTTP PUT, only the specified fields will be updated. You can un-set an optional value by specifying the parameter with an empty string. As an example, this group of parameters would unset any already specified end_time: &end_time=&paused=false.

See Error Codes & Responses for more details on error responses.

In-line parameters

Most resource URLs feature one or more in-line parameter. Many URLs also take explicitly declared parameters on the query string or, for POST or PUT requests, in the body.

In-line parameters are denoted with a pre-pended colon (”:”) in the Resource Path section of each resource. For example, if the account you were working on were identified as "abc1" and you were retrieving the campaigns associated with an account, you would access that list by using the URL https://ads-api.x.com/6/accounts/abc1/campaigns. By specifying the in-line account_id parameter described in the resource URL (https://ads-api.x.com/6/accounts/:account_id/campaigns), you’ve scoped the request to objects associated only with that account.

Using Access Tokens

The Twitter Ads API uses signed HTTPS requests to validate an application’s identity and also obtain the permissions granted to the end-user that the application is making API request on behalf of, represented by the user's access token. All HTTP calls to the Ads API must include an Authorization request header (using OAuth 1.0a) over the HTTPS protocol.

You will need to add support to generate OAuth 1.0a Authorization request headers to your application to integrate with the Twitter Ads API. However, due to the complexity of generating signed requests, we strongly recommended that partners use an existing library that either supports the Twitter API or implements OAuth 1.0a request handling - here is a list of recommended OAuth libraries and authentication code samples.

Note we can assist partners that encounter authentication errors when using a known library but cannot support custom OAuth implementations.

HTTP & OAuth

Like Twitter REST API v1.1, the Advertising API requires the use of both OAuth 1.0A and HTTPS. API keys can be obtained through the app management console. Access tokens must also be used to represent the “current user.” The current user is a Twitter account with advertising capabilities.

It is strongly recommended that partners use an OAuth library, rather than writing your own. We can support debugging when using a known library, but cannot if you roll your own OAuth implementation. See the libraries that you can use.

The API is strict with HTTP 1.1 and OAuth. Ensure that you’re encoding reserved characters appropriately within URLs and POST bodies before preparing OAuth signature base strings. The Advertising API in particular uses ”:” characters when specifying time and ”,” characters when providing a collection of options. Both characters are among this reserved set:

!

#

$

&

‘

(

)

*
  •  

,

/

:

;

=

?

@

[

]

%21

%23

%24

%26

%27

%28

%29

%2A

%2B

%2C

%2F

%3A

%3B

%3D

%3F

%40

%5B

%5D

Making your first API request with Twurl

Twitter helps maintain a command-line tool, Twurl, that supports OAuth 1.0a authorization headers as an alternative to cURL. Twurl provides a simple way of making authenticated API requests and exploring the Ads API before adding authentication to your application.

After installing and authorizing Twurl, you can quickly generate access tokens and make authenticated requests to the Ads API.

   twurl -H "ads-api.x.com" "/5/accounts/"

Take some time to get familiar with Twurl and the API by following this step-by-step tutorial for creating a campaign through the API.

Testing with Postman

For those who are not familiar with a command-line tool, we also provide a Postman collection for the Twitter Ads API endpoints.

Postman is one of the most popular API development tools that exist in the industry nowadays. It’s an HTTP client that has a great user interface that lets you make a complex API request easier and increases productivity.

To install Postman and start using the Ads API Postman collection, please see our set up guide.

Run in Postman

Extending your application to make authenticated requests

After getting familiar with making requests to the Ads API using Twurl, it is time to add support to create OAuth 1.0a authentication headers to your application.

OAuth 1.0a authentication headers include information that verifies both the application’s and user's identity as well as prevents tampering with the request. Your application will need to create a new Authorization header for each API request. Many languages have open source libraries that support creating this authorization header to make API requests to Twitter.

Here are some examples using C#, PHP, Ruby, and Python - code samples.

Custom Implementation

There are some scenarios that require implementing OAuth 1.0a authentication without the support of an open-source library. Authorizing a request provides detailed instructions for implementing support for creating the Authorization header. We strongly recommend using a community-supported library.

General outline:

  1. Collect 7 key/value pairs for the header - starting with oauth_
  2. Generate an OAuth 1.0a HMAC-SHA1 signature using those key/value pairs
  3. Build the Authorization header using the above values

Next Steps

After adding support for the Authorization header, you should have a simple application that can successfully make authenticated requests to the Twitter ads API.

To access another user’s Twitter Ads account, your application will need to obtain access tokens via the 3-legged OAuth flow.

If your application will only access your Twitter Ads account, proceed to the Upload Video and Promote Tweet Guide to upload Creatives that can be used in a campaign.

Resources

Development tools

  • Twurl -  command-line tool for interacting with the Twitter API
  • Postman - development tool for manually inspecting 3rd Party APIs

 

Twitter libraries that support the Ads API

  • Python - Twitter supported
  • Ruby - Twitter supported
  • Java - Twitter recommended

Request Header Authorization libraries that support OAuth 1.0a