Skip to main content

Base64 Encoder/Decoder is a simple tool for encoding and decoding Base64 strings. It supports both encoding text to Base64 and decoding Base64 back to text.

Project description

Base64 Encoder/Decoder API

Base64 Encoder/Decoder is a simple tool for encoding and decoding Base64 strings. It supports both encoding text to Base64 and decoding Base64 back to text.

Build Status Code Climate Prod Ready

This is a Python API Wrapper for the Base64 Encoder/Decoder API


Installation

Using pip:

pip install apiverve-base64encoderdecoder

Using pip3:

pip3 install apiverve-base64encoderdecoder

Configuration

Before using the base64 API client, you have to setup your account and obtain your API Key. You can get it by signing up at https://apiverve.com


Quick Start

Here's a simple example to get you started quickly:

from apiverve_base64encoderdecoder.apiClient import Base64APIClient

# Initialize the client with your APIVerve API key
api = Base64APIClient("[YOUR_API_KEY]")

query = {
    "text": "Hello World",
    "action": "encode"
}

try:
    # Make the API call
    result = api.execute(query)

    # Print the result
    print(result)
except Exception as e:
    print(f"Error: {e}")

Usage

The Base64 Encoder/Decoder API documentation is found here: https://docs.apiverve.com/ref/base64. You can find parameters, example responses, and status codes documented here.

Setup

# Import the client module
from apiverve_base64encoderdecoder.apiClient import Base64APIClient

# Initialize the client with your APIVerve API key
api = Base64APIClient("[YOUR_API_KEY]")

Perform Request

Using the API client, you can perform requests to the API.

Define Query
query = {
    "text": "Hello World",
    "action": "encode"
}
Simple Request
# Make a request to the API
result = api.execute(query)

# Print the result
print(result)
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "action": "encode",
    "original": "Hello World",
    "encoded": "SGVsbG8gV29ybGQ=",
    "length": 16
  }
}

Error Handling

The API client provides comprehensive error handling through the Base64APIClientError exception. Here are some examples:

Basic Error Handling

from apiverve_base64encoderdecoder.apiClient import Base64APIClient, Base64APIClientError

api = Base64APIClient("[YOUR_API_KEY]")

query = {
    "text": "Hello World",
    "action": "encode"
}

try:
    result = api.execute(query)
    print("Success!")
    print(result)
except Base64APIClientError as e:
    print(f"API Error: {e.message}")
    if e.status_code:
        print(f"Status Code: {e.status_code}")
    if e.response:
        print(f"Response: {e.response}")

Handling Specific Error Types

from apiverve_base64encoderdecoder.apiClient import Base64APIClient, Base64APIClientError

api = Base64APIClient("[YOUR_API_KEY]")

query = {
    "text": "Hello World",
    "action": "encode"
}

try:
    result = api.execute(query)

    # Check for successful response
    if result.get('status') == 'success':
        print("Request successful!")
        print(result.get('data'))
    else:
        print(f"API returned an error: {result.get('error')}")

except Base64APIClientError as e:
    # Handle API client errors
    if e.status_code == 401:
        print("Unauthorized: Invalid API key")
    elif e.status_code == 429:
        print("Rate limit exceeded")
    elif e.status_code >= 500:
        print("Server error - please try again later")
    else:
        print(f"API error: {e.message}")
except Exception as e:
    # Handle unexpected errors
    print(f"Unexpected error: {str(e)}")

Using Context Manager (Recommended)

The client supports the context manager protocol for automatic resource cleanup:

from apiverve_base64encoderdecoder.apiClient import Base64APIClient, Base64APIClientError

query = {
    "text": "Hello World",
    "action": "encode"
}

# Using context manager ensures proper cleanup
with Base64APIClient("[YOUR_API_KEY]") as api:
    try:
        result = api.execute(query)
        print(result)
    except Base64APIClientError as e:
        print(f"Error: {e.message}")
# Session is automatically closed here

Advanced Features

Debug Mode

Enable debug logging to see detailed request and response information:

from apiverve_base64encoderdecoder.apiClient import Base64APIClient

# Enable debug mode
api = Base64APIClient("[YOUR_API_KEY]", debug=True)

query = {
    "text": "Hello World",
    "action": "encode"
}

# Debug information will be printed to console
result = api.execute(query)

Manual Session Management

If you need to manually manage the session lifecycle:

from apiverve_base64encoderdecoder.apiClient import Base64APIClient

api = Base64APIClient("[YOUR_API_KEY]")

query = {
    "text": "Hello World",
    "action": "encode"
}

try:
    result = api.execute(query)
    print(result)
finally:
    # Manually close the session when done
    api.close()

Customer Support

Need any assistance? Get in touch with Customer Support.


Updates

Stay up to date by following @apiverveHQ on Twitter.


Legal

All usage of the APIVerve website, API, and services is subject to the APIVerve Terms of Service and all legal documents and agreements.


License

Licensed under the The MIT License (MIT)

Copyright (©) 2026 APIVerve, and EvlarSoft LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

apiverve_base64encoderdecoder-1.2.0.tar.gz (11.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

apiverve_base64encoderdecoder-1.2.0-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

Details for the file apiverve_base64encoderdecoder-1.2.0.tar.gz.

File metadata

File hashes

Hashes for apiverve_base64encoderdecoder-1.2.0.tar.gz
Algorithm Hash digest
SHA256 f7670aadda8dc2695b3ed7a782ef8e66601f7cfdd4b39ce5faca9bd997c642f0
MD5 ad595591388a640be643863f82c23bb7
BLAKE2b-256 2f100620723136d29dd59dfeabdd1060564dda80439799b55a12101ab4e7a858

See more details on using hashes here.

File details

Details for the file apiverve_base64encoderdecoder-1.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for apiverve_base64encoderdecoder-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 180bc1e17c30a433e430f3804af41b3f9a045e8e948cc6c26a56239e0e8ab79d
MD5 92fa25502c96bd820a6a8ab51455cdd9
BLAKE2b-256 4c1751c18346ae30038c246680454e33cbb113f400f9150d99a1fabbe390bd3a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page