Skip to content

Martini Configuration & Authentication for Consuming REST APIs

Integrating with REST APIs requires careful configuration and authentication to ensure secure and reliable communication between Martini and external services. This section delves into the specifics of configuring API triggers in Martini and authenticating requests using supported authentication mechanisms.

Configuration Steps

  1. Trigger Configuration

    • Identify the base URL of the REST API you intend to consume.
    • In Martini, navigate to the API integration settings and specify the base URL along with any required header parameters, such as content type or API version.

  2. Parameter Configuration

    • Define necessary query parameters or headers that are required for all requests to the API.
    • For dynamic parameters, such as those that change per request, configure these within the individual Gloop services generated for API operations.

Authentication Methods

Martini supports various authentication methods to secure API requests. Choose the method based on your API's security requirements:

  1. Basic Authentication

    • Used for APIs that require a username and password.
    • Configure the credentials in Martini, which will automatically encode them and add the Authorization header to your requests.

  2. OAuth2

    • For APIs protected by OAuth2, Martini needs the client ID, client secret, authorization URL, and token URL.
    • Martini can handle different OAuth2 flows (e.g., client credentials, authorization code) by storing tokens and refreshing them as needed.

  3. API Key

    • Some APIs require an API key passed as a query parameter or in the request header.
    • Configure the API key in the service settings, specifying how it should be included in requests.

Securing API Consumption

When consuming secured APIs, consider the following:

  • Credentials Storage: Use Martini's secure storage options to store sensitive information like passwords, client secrets, or API keys.
  • HTTPS: Always use HTTPS triggers for API integration to ensure encrypted communication.
  • Scope and Permissions: Apply the principle of least privilege by requesting only the necessary permissions from the API for the intended operations.

Testing and Validation

After configuring the API connection and authentication settings:

  • Utilize Martini's testing features to send mock requests to the API.
  • Verify that the API responds as expected and that the authentication process is successful.