Humance
  • Introduction
  • Features and Capabilities
  • Account and API Keys
  • SDK Installation and Setup
  • Contribution Collection System (Billing)
  • User Data Hashing
  • Share Functionality
  • Testing & QA
  • Errors and Troubleshooting
  • Help
Powered by GitBook
On this page

Was this helpful?

  1. Endpoints

Main Component

Last updated 5 months ago

Was this helpful?

The Main Component endpoint retrieves a combined list of projects and stories for a user. It adapts based on whether the user has supported projects previously or is new to the platform.


Get projects and stories

GET /company/integration/projects-stories

Request Parameters (Query String)

Name
Type
Nullable
Required
Description

user_hash

string

Yes

No

The unique hash identifier for the user. If omitted, the response defaults to 4 new projects for new users.

Response Structure

The response returns a list of projects with the following fields:

Field
Type
Description

project_id

integer

The unique identifier for the project.

project_name

string

The name of the project.

project_image_url

string

The URL for the project's image.

is_supported

boolean

Indicates whether the user supports this project.

has_stories

boolean

Indicates whether the project has any stories.

has_unviewed_stories

boolean

Indicates whether the user has unviewed stories for this project.

Behavior

The response adapts based on the user's status:

  1. New User (No user_hash)

    • The query is sent without a user_hash.

    • The response contains 4 new projects that the user hasn’t supported yet.

    • All projects have "is_supported": false.

  2. Returning User (With user_hash)

    • The query includes the user_hash.

    • The response contains the user's supported projects (with their support statuses and story updates) followed by new projects they haven’t supported.

Example Response:

{
  "data": [
    {
      "project_id": 18,
      "project_name": "Building of the coral plantation Gath'era 2",
      "project_image_url": "https://humance.io/storage/files/Ert7JcflRkGIj3quLIO6qr1C4kKEvzUm3jdHknfj.jpg",
      "is_supported": true,
      "has_stories": true,
      "has_unviewed_stories": true
    },
    {
      "project_id": 26,
      "project_name": "Rehabilitation center for sea turtles",
      "project_image_url": "https://humance.io/storage/files/Ert7JcflRkGIj3quLIO6qr1C4kKEvzUm3jdHknfj.jpg",
      "is_supported": false,
      "has_stories": false,
      "has_unviewed_stories": false
    },
    {
      "project_id": 28,
      "project_name": "Research Expedition in Greenland",
      "project_image_url": "https://humance.io/storage/files/Ert7JcflRkGIj3quLIO6qr1C4kKEvzUm3jdHknfj.jpg",
      "is_supported": true,
      "has_stories": true,
      "has_unviewed_stories": false
    },
    {
      "project_id": 29,
      "project_name": "Planting 50,000 trees in Madagascar",
      "project_image_url": "https://humance.io/storage/files/Ert7JcflRkGIj3quLIO6qr1C4kKEvzUm3jdHknfj.jpg",
      "is_supported": true,
      "has_stories": false,
      "has_unviewed_stories": false
    }
  ]
}