RBA API Access, Guidance and Support

RBA-Online API Guidance for Members.

RBA APIs enable authorized member organizations to connect supported RBA platforms with their own systems and applications. This page explains how to request API access, obtain support for existing API access, and understand the authorization process.

Looking for help?

Use Request API Access if a user does not currently have API access.
Use Request API Support if API access already exists, but you need assistance with a technical issue or question.

API overview

API access is intended to support authorized use of RBA data and services by eligible member organizations. The platforms and information available through an API may vary by service, your organization's access, and the API functionality available for that platform.

Choose what you need

Request API Access

Use this option when you or another authorized user at your organization needs API access.

Request API Access ↓

Request API Access

Get API Support

Use this option when API access already exists, but you need assistance with a technical issue or an API question.

Get API Support ↓

Request API Support


Before requesting API access

Before submitting an API access request, please identify:

  • The individual who requires API access
  • The email address that will be associated with API access
  • The member company the user represents
  • The platform for which API access is required
  • The intended business purpose or use case

Prime Contact authorization is required.

API access must be authorized by your organization's Prime Contact. You do not need to obtain this authorization before submitting your request. The assigned RBA Helpdesk agent will contact the Prime Contact and document the authorization before provisioning API access.


Request API access

Use the Request API Access option if you or another user at your organization does not currently have the required API access.

Selecting the link below will open a pre-addressed email to the RBA Helpdesk. Complete the requested information before sending the message.

Request API Access

What information will we need?

  • Requester name and email address
  • Member company name
  • API user's full name and email address
  • Platform for which API access is requested
  • Business purpose or use case
  • Any additional information relevant to the request

What happens after I submit my request?

  1. Request submitted – The RBA Helpdesk receives the request.
  2. Request validated – The assigned agent reviews the user, company, platform, and request information.
  3. Authorization obtained – The assigned agent obtains approval from the organization's Prime Contact.
  4. Access provisioned – Once authorization is documented, the RBA Helpdesk provisions the approved API access.
  5. Completion confirmed – The requester is notified when provisioning is complete.
Request → Validation → Prime Contact Authorization → Provisioning → Completion

Get API support

If API access has already been provisioned but you are experiencing an issue or have a technical API question, use the Request API Support option. Please do not submit another API access request to report a technical problem with existing access.

Request API Support

Help us investigate efficiently

When reporting an API issue, provide as much of the following information as possible:

  • Affected platform
  • Type of API issue or question
  • API endpoint or function involved, if known
  • Expected result
  • Actual result
  • Error message or error code
  • Approximate date and time of the issue
  • Whether the problem is ongoing or intermittent
  • Business impact
  • Troubleshooting already attempted
  • Relevant screenshots or supporting information
Tip: When possible, include both the expected result and the actual result. This can significantly improve initial troubleshooting and help determine where additional investigation is required.

API guidance and documentation

Before submitting a support request, review the available API documentation and guidance for the platform you are using.

API documentation may include guidance covering:

  • Getting started
  • Authentication
  • Available API functionality
  • Endpoints and parameters
  • Requests and responses
  • Data definitions
  • Errors and troubleshooting

Reviewing the available documentation before opening a support request may help you resolve common API questions without waiting for assistance.


Security and credential protection

Never send authentication credentials to the RBA Helpdesk.

Do not include any of the following in an email, support request, screenshot, or attachment:

  • Passwords
  • API keys
  • Access tokens
  • Authentication secrets
  • Private credentials

Before submitting screenshots or logs, review the information and remove or obscure sensitive authentication details.


Frequently asked questions

Do I need authorization to receive API access?

Yes. API access requires authorization from your organization's Prime Contact.

Do I need to obtain Prime Contact approval before submitting my request?

No. Submit your API access request first. The assigned RBA Helpdesk agent will contact the organization's Prime Contact and document the required authorization before provisioning access.

Can I request API access for another person?

Yes. Provide the requester's information, as well as the full name and email address of the individual who requires API access.

Why do I need to identify the platform?

Identifying the platform helps the RBA Helpdesk correctly validate, fulfill, route, and track your request.

I already have API access, but it is not working. Should I submit another access request?

No. If API access has already been provisioned, use the Request API Support option instead.

What should I provide when reporting an API issue?

Include the affected platform, endpoint or function if known, expected and actual results, error information, approximate date and time, business impact, and troubleshooting already attempted.

Should I send my API key or access token to the Helpdesk?

No. Never send API keys, passwords, access tokens, authentication secrets, or other credentials to the RBA Helpdesk.

Who supports API services?

Data Analytics owns API support. The RBA Helpdesk manages API access requests and provisions approved API user access. When a technical API issue requires additional investigation, the Helpdesk coordinates with the appropriate support team.


Still need assistance?

Choose the option that best describes what you need:

Back to top

 

Guidance Document

 

RBA API Field Map 

RMI API Field Map

 

 

RSCI API Field Map