streambird 1.0.5

The official Python client library for Streambird.io, the Passwordless Authentication Platform

Streambird | Python API Client

Installation

Install with PyPI (pip)

$ pip install --upgrade streambird

or install with Anaconda (conda)

$ conda install -c conda-forge streambird

Usage

import streambird

sb_client = streambird.Client("YOUR_API_KEY_HERE")

Example

Start a email magic link flow:

sb_client.magic_links.email.login_or_create(
    email='[e-mail]',
    login_redirect_url='https://example.com/login',
    registration_redirect_url='https://example.com/register',
)

Verify the magic llink token:

sb_client.magic_links.verify(
    token='bbqg5fxQrCkgIZr3HyWlxNdZ5l_lDNPrRlxnQ0KHTBk',
)

Error handling

If something went wrong while making API calls, then exceptions will be raised automatically as a StreambirdException parent type and child exceptions:

• StreambirdInvalidRequest: 400 - Bad Request -- The request was unacceptable, often due to missing a required parameter.
• StreambirdUnauthorized: 401 - Unauthorized -- No valid API key provided.
• StreambirdNotEnabled: 402 - Not enabled -- Please contact [e-mail] before creating this type of task.
• StreambirdResourceNotFound: 404 - Not Found -- The requested resource doesn't exist.
• StreambirdDuplicateResource: 409 - Conflict -- Object already exists with same name, idempotency key or unique_id.
• StreambirdTooManyRequests: 429 - Too Many Requests -- Too many requests hit the API too quickly.
• StreambirdInternalError: 500 - Internal Server Error -- We had a problem with our server. Try again later.
• StreambirdServiceUnavailable: 503 - Server Timeout From Request Queueing -- Try again later.
• StreambirdTimeoutError: 504 - Server Timeout Error -- Try again later.

Check out Streambird's API documentation for more details.

Troubleshooting

If you notice any problems, please email us at [e-mail].