About this guide

This guide is intended as a user guide, to provide information on connecting to Thredd services using Thredd's Secure Framework for the first time. It also provides information for existing clients that connect to Thredd via AWS and VPN.

Target audience

This guide is aimed at developers and system integrators who need to set up secure connections to Thredd services as a new client. It provides information for security consultants and Chief Information Security Officers (CISOs) who need to assess Thredd's security infrastructure.

If you are an existing Thredd client and Thredd has contacted you about migrating your existing connectivity with Thredd services, see the dedicated Migration Guide.

What's changed?

If you want to find out what's changed since the previous release, see the Document History section.

Terminology used in this guide

In this document, any terms in italics follow the standard (normative) terminology referenced in the OAuth 2.0 authorisation framework. For more information, see the IETF OAuth 2.0 Authorization Framework.

How to use this guide

If you are new to Thredd and its security infrastructure, you should refer to the Secure Framework and Setup Steps to understand how to connect to Thredd. To learn about the set up steps that you need to complete, refer to the relevant sections.

Other documentation

Refer to the table below for a list of other relevant documents that you should use together with this guide.

Document

Description

Key Concepts Guide

Provides an introduction to card payments and how describes how Thredd supports your card program.

REST API via API Hub (V2.0)

Explains how to use the endpoints available in Thredd's latest REST APIs via API Hub (V2.0).

Cards API (V1.0)

Explains how to use the endpoints available in Thredd's legacy Cards API (V1.0), which uses REST.

Web Services Guide (SOAP)

Provides information on the available Thredd web services and fields in each web service.

EHI Guide

Provides details of the Thredd External Host Interface (EHI).

Thredd Portal Guide

Explains how you can use the Thredd Portal guide for managing cards.

Card Transaction System Guide

Describes how to submit card test transactions in the UAT environment.

For the latest technical documentation, see the Documentation Portal.