API Documentation
Important terms
| Stakeholder | We refer to the all the players in the Tanzania innovation sector collectively as stakeholders. |
|---|---|
| Classification | Stakeholders are categorized in to 9 categories Research Institution, Hub, Support Institution, Government Entity, Civil Society Organization, Development Agency, Startup & Enterprise, Private Company, Market Facilitato |
| Type | Stakeholders in the Hub and Support Institution classifications can be further subcategorized by type, for instance a Hub can be sub categorized into Makerspace. |
Accessing the API
Registering Your Application
Before you start making any accessing the API, you need to first register an app in your apps page. Once you've created an app, you'll be provided with an API token to use when accessing the innovators data either directly or using one of the provided SDKs. You need to create an account and be logged in first before you can create an app.
Making Requests
The available endpoints are listed below in the resources section, along with embedded examples showing how they work and what they return.
Available Endpoints
Fetch Stakeholders
Get a paginated list of mapped stakeholders along with their important details such as location coordinates and classification.
https://innovate.co.tz/api/public/stakeholdersParameters
| Field | Type | Description |
|---|---|---|
| clientId | String |
Your app Id, You can pass it as query parameter or part of request body |
| limit optional | String |
Limit of returned documents per page |
| page optional | String |
Current page |
| search optional | String |
Search term |
| sector optional | String |
Filter by sector |
| status optional | String |
Filter by Approval Status ie Pending, Approved or Rejected |
| innovationStage optional | String |
Filter by innovationStage |
| classification optional | String |
Filter by classification |
| innovationType optional | String |
Filter by innovationType |
| yearFounded optional | String |
Filter by year founded ie Stakeholders that are founded before or on that year and are still active |
{
"data": [
{
"location": {
"coordinates": [
234,
-1234
]
},
"approvalStatus": {
"status": "Approved",
"user": {
"_id": "5f3f642804d4321a0964153e",
"firstName": "HDIF",
"lastName": "Admin",
"email": "hdiftanzania@gmail.com"
},
"reason": null
},
"socialMedias": [
{
"twitter": "https://twitter.com/ipfsotwares"
}
],
"services": [],
"mapper": {
"_id": "5f40d184cdd00b3e7075fdd3",
"firstName": "Jane",
"lastName": "Doe",
"email": "jdoe@example.com"
},
"isSelfMapped": false,
"associatedHubs": [],
"sectors": [],
"innovationTypes": [
"Service"
],
"_id": "5f40f6699c684d6ee106ce2d",
"locationName": "Kimara",
"name": "iPF softwares",
"email": "info@ipfsoftwares.com",
"region": "Dar Es Salaam",
"challengesAttended": [],
"attachments": [],
"createdAt": "2020-08-22T10:41:45.437Z",
"updatedAt": "2020-08-24T08:37:13.008Z",
"__v": 0
}
],
"total": 2,
"limit": 1,
"pageCount": 1,
"page": 1,
"pagingCounter": 1,
"hasPrevPage": false,
"hasNextPage": false,
"prev": null,
"next": null
}Error 4xx
| Name | Description |
|---|---|
| NotAuthenticated | API-Client not authenticated. |
HTTP/1.1 401 Unauthorized
{
"status": false,
"message": "Not Authenticated."
}View stakeholder details
Fetch a specific stakeholder details.
https://staging-api.innovate.co.tz/api/public/stakeholders/:idParameters
| Field | Type | Description |
|---|---|---|
| clientId | String |
Your app Id, You can pass it as query parameter or part of request body |
| id | String |
The ID of Stakeholder |
{
"location": {
"type": "Point",
"coordinates": [
-104.9903,
39.7392
]
},
"approvalDetails": {
"status": "Approved",
"user": null
},
"socialMedias": [
{
"twitter": "https://twitter.com/ipfsotwares"
}
],
"services": [],
"mapper": "5f50bc8c282c1300172e8fb6",
"isSelfMapped": false,
"associatedHubs": [],
"sectors": [],
"innovationStages": [],
"innovationTypes": [],
"_id": "5f50d88e84f4cb0017207339",
"locationName": "Kimara",
"name": "iPF softwares",
"email": "info@ipfsoftwares.com",
"contactPerson": {
"name": "Jane Ulomi",
"email": "janedoe@gmail.com"
},
"region": "Dar Es Salaam",
"challenges": [],
"implementer": {
"name": "John Ulomi",
"email": "johndoe@ipfsoftwares.com"
},
"attachments": [],
"createdAt": "2020-09-03T11:50:38.838Z",
"updatedAt": "2020-09-03T11:50:38.838Z",
"__v": 0
}Error 4xx
| Name | Description |
|---|---|
| NotAuthenticated | API-Client not authenticated. |
HTTP/1.1 401 Unauthorized
{
"status": false,
"message": "Not Authenticated."
}