Authentication

To access Humance API endpoints securely, all requests must include API keys in the headers. This section explains how to authenticate your requests and handle parameters if needed.

API Keys

Humance provides four API keys:

  • Production

    • API-Key

    • API-Secret

  • Test

    • API-Key

    • API-Secret

Generate these keys through your Humance account.

Always use the Test keys for development and switch to Production keys when deploying to a live environment.

Including Headers in Requests

All API requests must include the following HTTP headers for authentication:

HEADERS:
API-Key: <Your API Key>
API-Secret: <Your API Secret Key>

Replace <Your API Key> and <Your API Secret Key> with the keys from your Humance account.

Request URL Structure

  • Protocol: All requests must use HTTPS.

  • Domain: All requests are sent to humance.io.

  • Base Path: Endpoints begin with /company/integration/

Example Request:

GET https://humance.io/company/integration/get/projects
HEADERS:
API-Key: <Your API Key>
API-Secret: <Your API Secret Key>

Hand Parameters

1. Query Parameters (GET requests)

Some API requests require query parameters to refine results.

Example Endpoint: GET /company/integration/get/project/{project_id}

  • Path Parameter:

    • project_id (string): The ID of the project to retrieve.

  • Query Parameters:

    • highlights (integer, optional): Include project highlights (1 for yes, 0 for no).

    • description (integer, optional): Include project description (1 for yes, 0 for no).

Example Request:

GET https://humance.io/company/integration/get/project/160?highlights=1&description=1
HEADERS:
API-Key: <Your API Key>
API-Secret: <Your API Secret Key>

2. Body Parameters (POST requests)

For some API calls, you must send parameters in the request's body. Humance supports two formats:

  • application/json

  • multipart/form-data

Example Endpoint: POST /company/integration/orders/make

Body Parameters:

  • project_id (integer, required): ID of the project for which you want to create a payment.

  • amount (string, required): Payment amount in U.S. dollars, using a dot to indicate cents.

  • user_hash (string, required): Encrypted email of the user.

  • name (string, optional): First name of the user.

Example Request:

POST https://humance.io/company/integration/create/payment
HEADERS:
Content-Type: application/json
API-Key: <Your API Key>
API-Secret: <Your API Secret Key>
BODY:
{
    "project_id": 4,
    "amount": "100.20",
    "user_hash": "user@mail.com",
    "name": "Jack"
}

Last updated