Authentication#

Your API probably has some kind of authentication needs in order for us to talk to it on behalf of a user. Zapier supports the following authentication schemes: Basic Auth, Digest Auth, API Keys or OAuth V2.

Basic Auth#

What a user sees:

What a developer sees in the Web Builder:

See also: Basic auth via CLI

Classic Basic Auth, where users provide Zapier their username and password to authenticate with your API. This is also the scheme you want to use if your API relies on Basic Auth, but with atypical values for the username and password. For instance, an API that uses an API Key as the username and a dummy value as the password would still want to select Basic Auth for their App.

Digest Auth#

Users will provide Zapier their username and password, and we will handle all the nonce and quality of protection details automatically.

See also: Digest Auth via CLI

API Keys#

What a user sees:

Inside the developer platform for devs:

See also: API Key auth via CLI

Typically, you'll provide your users with an API Key inside your app somewhere. Many times these are provided on the user's settings or accounts page. These keys can be given to Zapier by the user so that we may make authenticated requests to access that user's information on their behalf.

Define any data which you Zapier must always include with each request as auth fields. Eg. api_key, account_name, etc.

Session-based Auth#

What the user sees:

Inside the developer platform for devs:

See also: Session auth via CLI

Be sure to tweak which fields are necessary for Zapier successfully attain a valid session with your API. Zapier will then store the credentials for this session until they expire, refreshing them only after encountering a 401, or when specified by the get_session_info method provided in your your custom scripting.

OAuth#

↑ Was this documentation useful? Yes No
Get Help