Skip to content

Developer Service

Manage your developer profile, including viewing account details, updating settings, and regenerating your API key.

Initialize the Service

from vclient import developer_service

developer = developer_service()

Available Methods

Method Returns Description
get_me() MeDeveloper Retrieve your developer profile
update_me(request=None, **kwargs) MeDeveloper Update your profile fields
regenerate_api_key() MeDeveloperWithApiKey Generate a new API key

Examples

Retrieve Your Profile

Get your authenticated developer account details.

me = await developer.get_me()
print(f"Username: {me.username}")
print(f"Companies: {len(me.companies)}")

companies lists only the companies you currently have access to. Companies whose access was revoked are left out.

Update Your Profile

Modify your developer account settings. You can pass a model object or use keyword arguments.

from vclient.models import MeDeveloperUpdate

# Option 1: Use a model object (preferred)
update = MeDeveloperUpdate(username="new_username", email="newemail@example.com")
updated = await developer.update_me(update)

# Option 2: Pass fields as keyword arguments
updated = await developer.update_me(username="new_username")

# Option 3: Register per-developer OIDC audiences
updated = await developer.update_me(
    provider_audiences={
        "apple": ["com.example.iosapp"],
        "google": ["1234-abc.apps.googleusercontent.com"],
    }
)

Regenerate API Key

Generate a new API key for authentication. The API invalidates the current key immediately, so the client switches to the new key for every later request, including requests from services it already created.

result = await developer.regenerate_api_key()
print(f"New API Key: {result.api_key}")

Save Your API Key

Regenerating your API key immediately invalidates the current key. Save the new key from the response, because it will not be displayed again. The client never sends an idempotency key for this call and never retries it after a network or server error, so a failed call may or may not have rotated the key. A 429 is still retried. Any other process or client that uses the old key gets AuthenticationError until you give it the new key.

  • Response Models - View MeDeveloper and MeDeveloperWithApiKey model schemas
  • Identity Service - Registering provider_audiences is what enables Apple and Google verified logins for your apps