Skip to main content

Documentation Index

Fetch the complete documentation index at: https://documentation.byteful.com/llms.txt

Use this file to discover all available pages before exploring further.

The Byteful API uses API keys for authentication. Each request must include both your public and private API keys in the request headers. This ensures that only authorized users can access the API.

​
API Keys

You’ll need to use two keys for authentication:
  • Public API Key: Identifies your account
  • Private API Key: Verifies your identity (keep this secure)
These keys must be included in the headers of every request to the API.

​
Authentication Headers

Include the following headers in all your API requests:
HeaderDescription
X-API-Public-KeyYour public API key
X-API-Private-KeyYour private API key

​
Security Best Practices

  • Never share your private key: Keep your private API key confidential
  • Use environment variables: Store keys in environment variables rather than hardcoding them
  • Rotate keys periodically: Change your API keys regularly as a security best practice

​
Basic Authentication Example

This example shows how to authenticate and retrieve customer information using the /customer/retrieve endpoint: 
# Basic authentication and customer information retrieval
curl --request GET \
  --url 'https://api.byteful.com/1.0/public/customer/retrieve' \
  --header 'X-API-Public-Key: your_public_key' \
  --header 'X-API-Private-Key: your_private_key'

​
Troubleshooting Authentication Issues

If you encounter authentication errors, check the following:
ErrorPossible CauseSolution
401 UnauthorizedInvalid API keysVerify your API keys are correct and properly formatted
No responseNetwork issuesCheck your network connection and firewall settings

​
API Key Management

You can manage your API keys through the Byteful dashboard:
  1. Log in to your account
  2. Navigate to the API Keys section
  3. View your current keys or generate new ones