Click here to load reader

Oracle Responsys for developers who use the Oracle Responsys REST API to access ... Oracle Responsys REST API Upgrade Guide ... contact your Customer Success

  • View
    320

  • Download
    11

Embed Size (px)

Text of Oracle Responsys for developers who use the Oracle Responsys REST API to access ... Oracle...

  • Oracle Responsys

    REST API Developers Guide

    REST API v1.3

    E65150-17

    May 2018

    Documentation for developers who use the Oracle Responsys REST API to access the data, content, and campaign management features of Oracle Responsys

    IMPORTANT: The v1.3 REST APIs documented in this guide are intended for use with Oracle Responsys 18B and later.

    If you need to obtain documentation for the v1.1 REST APIs, which are still compatible with Oracle Responsys 18B, it is available at the following location: https://community.oracle.com/docs/DOC-1010946

    For more details about the differences between the v1.3 and v1.1 REST APIs, please refer to the Changes and Enhancements and Migration Notes sections of this document.

    https://community.oracle.com/docs/DOC-1010946

  • Oracle Responsys REST API Developers Guide 2018 Page ii

    Oracle Responsys REST API Developers Guide E65150-17

    Documentation for developers who use the Oracle Responsys REST API to access the data, content, and campaign management features of Oracle Responsys. Copyright 2018 Oracle Responsys, Inc. All rights reserved.

    Information in this document is subject to change without notice. Data used as examples in this document is fictitious. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, without prior written permission of Oracle Responsys. Address permission requests, comments, or suggestions about Oracle Responsys documentation by creating a MOS Service Request at https://support.oracle.com.

    https://support.oracle.com/

  • Oracle Responsys REST API Developers Guide 2018 Page iii

    Contents Changes and Enhancements in Recent Releases .......................................................................................... 1

    Changes and Enhancements in 18B .......................................................................................................... 1

    REMINDER: REST API Version 1 will be deprecated September 2018 .................................................. 1

    Updated throttling limits ...................................................................................................................... 1

    New standard REST API endpoints ........................................................................................................ 1

    Changes and Enhancements in 18A .......................................................................................................... 2

    New naming convention for Responsys Quarterly Product Updates ................................................... 2

    REST API Version 1 will be deprecated September 2018...................................................................... 2

    New standard REST API endpoints ........................................................................................................ 2

    Changes and Enhancements in 6.33 ......................................................................................................... 2

    Changes and Enhancements in 6.32 ......................................................................................................... 3

    Overview ....................................................................................................................................................... 4

    About this guide ........................................................................................................................................ 4

    Conventions used in this document ..................................................................................................... 5

    About the Oracle Responsys REST API ...................................................................................................... 5

    Processing Responsys REST API requests ..................................................................................................... 6

    API Call Processing .................................................................................................................................... 6

    How Enactment Batching Affects Processing ........................................................................................... 7

    Access Controls ............................................................................................................................................. 7

    Organizational access control ................................................................................................................... 7

    Functional access control .......................................................................................................................... 8

    Login IP enforcement access control ........................................................................................................ 8

    Authenticating .............................................................................................................................................. 9

    Login with username and password ......................................................................................................... 9

    Login with username and certificates ..................................................................................................... 10

    Refresh token .......................................................................................................................................... 12

    Get Throttling Limits ................................................................................................................................... 12

    Managing Profile List Tables ....................................................................................................................... 15

    Retrieving all profile lists for an account ................................................................................................ 15

    Merge or update members in a profile list table .................................................................................... 18

  • Oracle Responsys REST API Developers Guide 2018 Page iv

    Retrieve a member of a profile list using RIID ........................................................................................ 20

    Retrieve a member of a profile list based on query attribute ................................................................ 22

    Delete Profile List Recipients based on RIID ........................................................................................... 24

    Managing Profile Extension Tables ............................................................................................................. 26

    Retrieve all profile extensions of a profile list ........................................................................................ 26

    Create a new profile extension table ...................................................................................................... 28

    Merge or update members in a profile extension table ......................................................................... 29

    Retrieve a member of a profile extension table based on RIID .............................................................. 32

    Retrieve a member of a profile extension table based on a query attribute ......................................... 34

    Delete a member of a profile extension table based on RIID ................................................................. 35

    Add or Update RIID-to-Audience Scope Code Mapping Data for Profile List members ......................... 37

    Managing Supplemental Tables .................................................................................................................. 41

    Retrieve all supplemental tables ............................................................................................................ 41

    Create a new supplemental table ........................................................................................................... 44

    Merge supplemental table records using primary key ........................................................................... 45

    Merge supplemental table records without primary key ....................................................................... 48

    Retrieve supplemental table records with primary key ......................................................................... 52

    Delete supplemental table records ........................................................................................................ 54

    Get All Campaigns ....................................................................................................................................... 56

    Get all EMD email campaigns ................................................................................................................. 56

    Get all Push campaigns ........................................................................................................................... 59

    Get all SMS campaigns ............................................................................................................................ 61

    Triggering Email Messages .......................................................................................................................... 64

    Merge members into a profile list and trigger email messages to them ............................................... 64

    Merge members into a profile list and trigger email messages with attachments ................................ 66

    Trigger email message ....................................

Search related