API documentation for Apple + Google NFC wallet credentials - AccessGrid

API Documentation

Everything you need to interact with AccessGrid.

Supported Languages

Install SDK

# install curl
npm install accessgrid
bundle add accessgrid
pip install accessgrid
go get accessgrid
Install-Package accessgrid.dll -Version 1.0.0
implementation "com.accessgrid.sdk:accessgrid:1.0.0"
composer require accessgrid/accessgrid
{:accessgrid, ">= 0.0.0"} # mix

Authentication

We use a dual authentication mechanism, it consists of two parts:

  1. A static account id to be sent in the X-ACCT-ID header
  2. A shared secret scheme to authenticate every API request with a signed payload in the X-PAYLOAD-SIG header

You can find both keys in your AccessGrid console on the API keys page. If you're logged in, they're automatically embedded into this documentation.

Otherwise, the code samples below reference your account id as $ACCOUNT_ID and your shared secret as $SECRET_KEY. Substitute them inline, or export them in your shell before running a snippet:

export ACCOUNT_ID="<your account id>"
export SECRET_KEY="<your shared secret>"

Rate Limits

API requests that provision Android passes (Google Wallet) are subject to rate limits based on Google's Wallet API guidelines. When issuing or updating Android passes, please observe the following limits:

These limits apply to operations that trigger Google Wallet API calls, including issuing new Android passes and updating existing ones. Requests exceeding these limits may be throttled or rejected.