
Linkable Networks, Inc. provides a RESTful API for use in building consumer applications on top of the Linkable platform. The Linkable API gives partners and independent developers access to the full range of Linkable card linked offer functionality, including offer display, offer linking, offer redemption tracking, new consumer registration, and consumer account management. Getting started with the Linkable API is easy – if you know REST and OAuth you know our API.
| GUIDE TO MYLINKABLES PLATFORM OBJECTS | |
|---|---|
| Consumers | The MyLinkables API enables you to CREATE (POST: consumerapi/consumer), VIEW (GET: consumerapi/consumer), and OPT-OUT (DELETE: consumerapi/consumer) consumers from MyLinkables |
| Offers | The MyLinkables API enables an authenticated entity access to all offer types AVAILABLE (GET: consumerapi/offers/available), LINKED (GET: consumerapi/offers/linked), REDEEMED (GET: consumerapi/offers/redeemed), and RESERVED (GET: consumerapi/offers/reserved). There is a special API endpoint if you just want to display a list of AVAILABLE offers in your mobile application or on your website. |
| Accounts | The MyLinkables API allows you to LIST (GET: consumerapi/accounts), ADD, UPDATE, and REMOVE (DELETE: consumerapi/accounts/${accountToken}) cards to which they link offers. ***Please note, adding and updating cards is only available to PCI-Compliant partners*** |
| MYLINKABLES API | |
|---|---|
| Authentication Method | OAuth 2.0 (Specifically the API supports OAuth's Resource Owner Password Credentials as described in section 4.3.) |
| Available Response Formats | JSON and XML |
| Current API Version | 1.0 |
Next steps? Send us an email with your contact information and we’ll send along our API documentation and your credentials.


