Prepare your first request

Before you start, identify what your integration needs to read or change and who on your team will maintain it. Have a Nimbo contact confirm the account, permissions, and environment for that workflow. For product options and access questions, see API e integraciones. For technical setup, prepare your test environment and keep credentials on your server.

Confirm your integration access

Describe what your software needs to read or update. Ask Nimbo to confirm the supported operations, permissions, and authentication method for that integration.

Get the correct API host

Use the base URL supplied for your integration and environment. dev.nimbo-x.com is the documentation site, not an API host. The api.example.test host in this site’s reference is a placeholder and cannot receive API requests.Check whether your supplied base URL already includes /api/v1 before adding an endpoint path. Include that prefix only once.

Set your environment

The examples below use NIMBO_API_BASE_URL for the API URL including /api/v1, with no trailing slash. Set it to the URL supplied by Nimbo. Use only synthetic records in your agreed test environment.

export NIMBO_API_BASE_URL="https://api.example.test/api/v1"

This placeholder cannot receive requests. Webhook management uses a separate base URL; see Webhooks.

Obtain an access token

Follow Authentication using the method approved for your account. Store the returned access_token securely as NIMBO_ACCESS_TOKEN in your local development environment. Do not put credentials or tokens in a committed script.

Make a read request

If organization access is enabled for your integration, request the current organization:

curl --include --request GET "$NIMBO_API_BASE_URL/organizations/current" \
  --header "Authorization: Bearer $NIMBO_ACCESS_TOKEN" \
  --header "Accept: application/json"

Inspect the response

The reference documents HTTP 200 for this operation but does not yet specify its response fields. Inspect the returned organization and confirm the fields your integration needs before creating records. A token error or unexpected organization is a reason to check access with Nimbo before proceeding.

Read Authentication before adding credentials, and Browse endpoints to find the endpoints for your integration. Next, create a patient, schedule an appointment, or build a patient portal. See Request conventions for URL construction, dates, and error handling.

Get started

Integration workflows

Explore the API