Authentication

Getting and managing your API keys

To access the Nodefy API, you'll need a valid API key.

How to Obtain Your API Key

To request an API key, please contact our team at [email protected]. We'll work with you to understand your specific use case and provide you with an API key.

Using Your API Key

Once you receive your API key, include it in the Authorization header of each request you make to the Nodefy API. Use the Bearer authentication scheme:

Authorization: Bearer YOUR_API_KEY 

Example (cURL):

curl -X GET 'https://api.nodefy.xyz/api/v1/webhooks/' \
     -H 'Authorization: Bearer YOUR_API_KEY'

Important Considerations

• Never share your API key publicly. Treat your API key as a confidential password.

• Security: We recommend using HTTPS to protect your API key during transmission. Additionally, consider storing your API key in an environment variable or secure configuration file rather than directly in your code.

Error Handling

If your API key is invalid or missing, you will receive a 401 Unauthorized error response:

{
  "error": "Unauthorized",
  "message": "Invalid or missing API key"
}