Test

login

POSThttps://ushahididocs.api.ushahidi.io/oauth/token

Body

application/x-www-form-urlencoded

username*string

The Ushahidi login username/email

Example: "[e-mail]"

password*string

The Ushahidi password

Example: "Doc@test2022"

grant_type*string

Login grant type. Use Password for this grant type

Example: "password"

client_id*string

The user client ID

Example: "ushahidiui"

client_secret*string

The client unique secret indentifier

Example: "35e7f0bca957836d05ca0492211b0ac707671261"

scopestring

You need to also provide the scope. you can add multiple scope to this parameters. (Scope Options - posts, country_codes, media, forms, api, tags, savedsearches, sets, users, stats, layers, config, messages, notifications, webhooks, contacts, roles, permissions, csv, tos dataproviders, migrate, apikeys)

Example: "posts country_codes media forms api tags savedsearches sets users stats layers config messages notifications webhooks contacts roles permissions csv tos dataproviders migrate apikeys"

Response

200

OK

Body

application/json; charset=UTF-8

token_type*string

expires_in*integer (int32)

access_token*string

refresh_token*string

Request

JavaScriptCurlPython

const response = await fetch('https://ushahididocs.api.ushahidi.io/oauth/token', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "client_id": "ushahidiui",
      "client_secret": "35e7f0bca957836d05ca0492211b0ac707671261",
      "grant_type": "password",
      "password": "Doc@test2022",
      "username": "[e-mail]"
    }),
});
const data = await response.json();

Response

200

{
  "token_type": "text",
  "expires_in": 0,
  "access_token": "text",
  "refresh_token": "text"
}

register

POSThttps://ushahididocs.api.ushahidi.io/api/v3/register

Body

application/json

email*string

password*string

Response

200422

OK

Body

application/json

id*integer (int32)

url*string

email*string

realname*nullable string

logins*integer (int32)

failed_attempts*integer (int32)

last_login*nullable string

last_attempt*nullable string

created*string

updated*nullable string

role*string

language*nullable string

contacts*array of string

allowed_privileges*array of string

gravatar*string

Request

JavaScriptCurlPython

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v3/register', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": "[e-mail]",
      "password": "test1234"
    }),
});
const data = await response.json();

Response

200422

{
  "id": 0,
  "url": "text",
  "email": "text",
  "realname": "text",
  "logins": 0,
  "failed_attempts": 0,
  "last_login": "text",
  "last_attempt": "text",
  "created": "text",
  "updated": "text",
  "role": "text",
  "language": "text",
  "contacts": [
    "text"
  ],
  "allowed_privileges": [
    "text"
  ],
  "gravatar": "text"
}

password reset

POSThttps://ushahididocs.api.ushahidi.io/api/v3/passwordreset

Body

application/json

email*string

Response

400500

Bad Request

Body

application/json

statusinteger

messagestring

Request

JavaScriptCurlPython

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v3/passwordreset', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": "[e-mail]"
    }),
});
const data = await response.json();

Response

400500

{
  "status": 0,
  "message": "text"
}

Confirm reset password

POSThttps://ushahididocs.api.ushahidi.io/api/v3/passwordreset/confirm

Body

application/json

statusinteger

messagestring

Response

204422

Body

application/json

integer (int32)

Example: 1

Request

JavaScriptCurlPython

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v3/passwordreset/confirm', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "password": "new password",
      "token": "fjdsk$#@frhgrigds"
    }),
});
const data = await response.json();

Response

204422

1

Get post revisions

GEThttps://ushahididocs.api.ushahidi.io/api/v3/posts/{parent_id}/revisions

Path parameters

parent_id*string

Parent Identifier

Query parameters

Response

200404

OK

Body

application/json

countsinteger

resultsarray of PostResponseList_results (object)

limitinteger

offsetinteger

orderstring

orderbystring

currstring

nextstring

prevstring

total_countinteger

Request

JavaScriptCurlPython

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v3/posts/{parent_id}/revisions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "counts": 0,
  "results": [
    {
      "id": 0,
      "url": "text",
      "user": [
        {
          "id": 0,
          "url": "text"
        }
      ],
      "parent_id": 0,
      "form": [
        {
          "id": 0,
          "url": "text"
        }
      ],
      "title": "text",
      "content": "text",
      "message": "text",
      "color": "text",
      "type": "text",
      "slug": "text",
      "author_email": "text",
      "author_realname": 0,
      "status": "text",
      "created": "text",
      "updated": "text",
      "locale": "text",
      "values": [
        "text"
      ],
      "post_date": "text",
      "tags": [
        "text"
      ],
      "published_to": [
        0
      ],
      "completed_stages": [
        0
      ],
      "sets": [
        0
      ],
      "lock": "text",
      "source": "text",
      "data_source_message_id": "text",
      "allowed_privileges": [
        "text"
      ]
    }
  ],
  "limit": 0,
  "offset": 0,
  "order": "text",
  "orderby": "text",
  "curr": "text",
  "next": "text",
  "prev": "text",
  "total_count": 0
}