Developer Guide

Getting Started

Welcome to the Odido Developer Portal. This guide walks you through setting up access and making your first successful request to an Odido REST API.

All APIs available through the portal are REST-based and use JSON over HTTPS.

Access Prerequisites

Access to the Odido Developer Portal and its APIs is restricted and contract-based. Before you can authenticate or subscribe to any API, the following prerequisites must be met:

• Active Odido customer relationship — Your organization must have an active commercial relationship with Odido.
• API addendum / Developer Portal agreement — API access requires a separate contractual agreement covering:
  • Access to the Odido Developer Portal
  • Applicable commercial and usage terms

Access to the portal is not provisioned automatically as part of standard customer contracts.

New to Odido APIs?
If you are evaluating our APIs, refer to the API landing page on odido.nl and submit the lead form. Your request will be routed to the appropriate commercial contact for follow-up.

Existing customer requesting API access
If your organization is already an Odido customer, contact your assigned account manager or commercial contact to initiate the API access agreement and provisioning process.

Once contractual access has been confirmed, a Developer Portal account can be created and you may proceed with the technical onboarding steps below.

Before You Begin

Make sure the following applies to you:

• You are an Odido customer
• A Developer Portal account has been created for you (registration is per environment)
• You have access to at least one API catalogue
• You have a development environment capable of making HTTPS requests
• You are familiar with basic REST concepts (HTTP methods, headers, JSON)

Environments

The Odido Developer Portal is available in multiple environments. Registration and credentials are separate per environment and are not shared.

• Dev: https://developer-dev.odido.nl/
• Agile: https://developer-agile.odido.nl/
• Staging: https://developer-staging.odido.nl/
• Production: https://developer.odido.nl/

Access to Production is separate from non-production environments.

Access Model

Access to APIs follows this structure:

Account → Catalogue → Product → API → Endpoints

• Your account provides access to one or more catalogues
• A catalogue contains products
• A product contains one or more APIs
• An API contains multiple endpoints

To use an API, you must subscribe to an API plan within the portal. After subscribing, you can create an application to obtain credentials. One application can access multiple APIs, depending on the subscriptions linked to it.

Step 1 — Log In

Log in to the appropriate Developer Portal environment.

• External users log in using 2FA
• Odido employees log in via SSO

If this is your first login, you will be prompted to configure your 2FA method.

Step 2 — Subscribe to an API

1. Navigate to the relevant catalogue
2. Select the product
3. Choose the API
4. Subscribe to an available API plan

Once subscribed, you can proceed to create your application.

Step 3 — Create an Application

To call an API, you must create an application in the portal. When creating an application:

• A Client ID is generated automatically
• A Client Secret is generated automatically

Important:

• The Client Secret cannot be regenerated
• If the secret is compromised, the application must be revoked and a new application must be created
• A user can create multiple applications

Store your credentials securely.

Step 4 — Obtain an Access Token

All Odido APIs use OAuth2 Client Credentials flow.

Token endpoint (per environment):

• Dev: https://connect-dev.odido.nl/realms/tyk-dev-portal/protocol/openid-connect/token
• Agile: https://connect-agile.odido.nl/realms/tyk-dev-portal/protocol/openid-connect/token
• Staging: https://connect-staging.odido.nl/realms/tyk-dev-portal/protocol/openid-connect/token
• Production: https://connect.odido.nl/realms/tyk-dev-portal/protocol/openid-connect/token

Token request example:

curl -X POST "https://connect-staging.odido.nl/realms/tyk-dev-portal/protocol/openid-connect/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id=YOUR_CLIENT_ID" \
  -d "client_secret=YOUR_CLIENT_SECRET"

The response contains an access token.

• The token type is Bearer
• Token validity: 300 seconds (5 minutes)

Step 5 — Make Your First API Request

Once you have obtained an access token, include it in the Authorization header of your request.

Example:

curl -X GET "https://api-base-url/example-endpoint" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Accept: application/json"

All APIs:

• Use HTTPS
• Return JSON responses
• Use standard HTTP status codes

Refer to the API Reference for endpoint-specific details.

Rate Limits

Rate limits may apply depending on the API plan you are subscribed to. For example, some plans may allow a defined number of requests per second. Daily or monthly quotas may vary depending on the API plan configuration.

Check the specific API plan details in the portal for applicable limits.

Next Steps

After successfully making your first call:

• Explore additional endpoints in the API Reference
• Review authentication and security best practices
• Monitor your usage in the portal
• Contact support if you encounter issues

You are now ready to build with Odido REST APIs.

curl --location 'https://connect-agile.odido.nl/realms/tyk-dev-portal/protocol/openid-connect/token' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'client_id=xxxxxxx' \
  --data-urlencode 'client_secret=xxxxxxxxxx' \
  --data-urlencode 'scope=Genesys_Services_Oauth_External demoplan' \
  --data-urlencode 'grant_type=client_credentials'

curl --location 'https://api-agile.odido.nl/oauth/genesyscloud/api/v2/outbound/contactlists' \
  --header 'x-auth-token: Bearer xxxxxxx'

curl -X POST "Token Endpoint" \
-H "Content-Type: application/x-www-form-urlencoded" \
--data-urlencode "client_id=<client-id>" \
--data-urlencode "client_secret=<client-secret>" \
--data-urlencode "scope=<scope permissions>" \
--data-urlencode "grant_type=client_credentials"

{
"access_token":"eyJhbGciOi......",
"expires_in":300,
"refresh_expires_in":0,
"token_type":"Bearer",
"scope":"scope1 scope2"
}

curl -X GET <api_base_url>/endpoint \
-H "Authorization: Bearer <access_token>"