BrM API QuickStart Guide

AASHTOWare OpenAPI – BrM API: Integration Reference

5/14/2025

AASHTOWare OpenAPI for AASHTOWare Bridge Management (BrM)

This guide provides step-by-step instructions to help you obtain your client credentials and test the BrM API. With these credentials, you can securely interact with the Bridge Management (BrM) features through the AASHTOWare OpenAPI framework.

1. Generating Client Credentials

Purpose:

Your client credentials (Client ID and Client Secret) provide secure access to the BrM API. It is essential to generate and store these credentials safely before making any API calls.

Step-by-Step Instructions:

  1. Log In to BrM:

    Begin by signing into your AASHTOWare Bridge Management account.

  2. Navigate to Security Settings:

    Go to Settings → General Configuration → Security → API Credentials. This is where you manage the credentials for API access.

  3. Create New Credentials:

    Click the Add New button. A prompt will appear asking you to give your new credentials a descriptive name. Choose a name that indicates its purpose (for example, "Development Credentials" or "Test API Access").

  4. Receive Your Credentials:

    After submitting the name, the system automatically generates a Client ID and a Client Secret.

  5. Important:

    The Client Secret is displayed only once. Save it immediately in a secure location because it will not be shown again.

  6. Secure Your Credentials:

    Ensure that you safeguard both the Client ID and Client Secret. They are essential for authenticating your API requests and should not be shared or exposed.

2. Testing via AASHTOWare OpenAPI

Purpose:

Confirm your API access and familiarize yourself with interacting with the BrM API by testing a token request. This step uses the AASHTOWare OpenAPI Developer Portal, which provides an interactive interface for making API calls.

Step-by-Step Instructions:

  1. Access the Developer Portal:

    Log in or create a new account at the AASHTOWare OpenAPI Developer Portal (accessible via the Home page).

  2. Request Access to the BrM API:

    Once logged in, navigate to the APIs tab. Locate the BrM API in the list and request access as outlined on the portal. This ensures you have the proper permissions to use the BrM service.

  3. Locate the Token Endpoint:

    Find the token endpoint at /{instance}/connect/token. Replace {instance} with your specific agency or test instance (for example, AGENCY-TEST).

  4. Initiate an API Call:

    Click the Try It button on the portal. This opens an interactive window where you can configure your request.

  5. Configure Your Request:

    • Parameters: Set instance to your applicable instance value (e.g., AGENCY-TEST).

    • Headers: Ensure the Content-Type is set to application/x-www-form-urlencoded.

    • Request Body (Raw):

      Insert the following body content, replacing YOUR_CLIENT_ID and YOUR_CLIENT_SECRET with the credentials you generated earlier:

      grant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET&scope=openid BrM.fullaccess BrM.readonly

      This request uses the OAuth 2.0 client credentials grant to obtain an access token. The scope parameter specifies the levels of access required for the BrM API.

  6. Execute the Request:

    Submit the request by confirming the form. Upon success, you will receive an authentication token. This token must be included in subsequent API calls to authenticate and authorize your requests.

Next Steps and Additional Information

After successfully securing your token, you can now explore the comprehensive API documentation for further integration details and advanced features.

  • Explore Endpoints: Experiment with different API endpoints provided on the developer portal.

  • Review Documentation: Familiarize yourself with rate limits, error responses, and best practices for managing and refreshing tokens.

  • Ensure Security: Always store your credentials securely and follow best security practices to prevent unauthorized access.

Taking the time to thoroughly understand this guide will prepare you for seamless integration and efficient usage of the BrM API. As you progress, consider exploring additional sections within the Developer Portal for more advanced functionalities and sample code snippets.