Getting Started

You can interact with the Creduse API through HTTP requests to our endpoints. After you sign up for an account, you will be able to generate an API key to authenticate your requests.

Authentication

Generate an API Key

The Creduse API uses API keys to authenticate requests. You can generate an API key by navigating to the API Key section of your account.

Treat your API key as a highly sensitive secret. Never share it with unauthorized parties or embed it directly in client-side code (such as browsers or mobile apps) where it could be exposed. Always ensure that production requests to the Creduse API are routed through your secure backend server, where the API key can be safely loaded from an environment variable or a dedicated key management service. Exposing your API key in client-side code poses a significant security risk and should be avoided at all costs.

All API requests should include your API key in an Authorization HTTP header as follows:

Authorization: Bearer $YOUR_API_KEY

Making requests

To interact with the Creduse API, you will need to compose HTTP requests to the appropriate endpoints. The base URL for all requests is: https://api.creduse.com.

Here's a sample request to subtract 1 credit from a user's balance:

curl -X POST {{$apiBaseUrl}}/subtract \
    -H "Authorization: Bearer $YOUR_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{"end_user_id": "UUID", "amount": 1}'

In response, you will receive a JSON object containing the relevant data. For the /subtract endpoint, the response will include the end_user_id and the amount of credits subtracted, as shown in the response model below:

{
  "end_user_id": "UUID",
  "amount": 1
}

This response structure may vary depending on the endpoint you're calling, but it will generally include the relevant information related to the requested operation.