Getting Started

Welcome! This guide will help you get started with the Caf Connect API, from creating your first application to making authenticated requests and understanding permissions.

Step 1: Create an application

To use the APIs, you first need to create an application in Trust. You will receive a client_id and client_secret.

• Access Creating an Application for step-by-step instructions.

Step 2: Understand permissions

Your application requires specific permissions to access different API features. Review and select the permissions needed for your use case.

• Access Available Permissions for a full list.

Step 3: Authenticate and obtain an access token

With your credentials, you can authenticate and obtain an OAuth2 access token. This token is required for all API requests.

• Learn how to authenticate in Authenticating.

Step 4: Set up mutual TLS (mTLS) authentication (recommended)

For enhanced security, Caf Connect supports mutual TLS (mTLS) authentication. This provides an additional layer of security by requiring both the client and server to verify each other's certificates.

1. Create a Certificate:

   • Follow the instructions in Creating a Certificate to generate a client certificate.

2. Configure mTLS in Your Application:

   • Implement mTLS authentication using your certificate and private key.

   • Access Using mTLS for code examples and detailed instructions.

Next steps

• Explore the Available Resources to see what you can do with the API.

• Review Managing Applications for tips on updating or deleting your applications.

• Learn about Managing Certificates to handle certificate renewal and revocation.

Tip: Keep your credentials and certificates secure and never expose them in client-side code or public repositories.