SignPuddle 3 User API


v3.0.0

user

SignPuddle 3 collections are organized by country and language codes

Who uses SignWriting?

List of countries with size and activity.

Retrieve country list

The available countries where signs are available.

REQUEST user-who

                          null

                        
                          
                        

RESPONSE

Headers
Content-Type text/plain
200 text/plain
                        BR
US

                      
                        
                      
User pass

A string for accounting and validation

String for accounting and validation

REQUEST user pass

                          null

                        
                          
                        

RESPONSE

Headers
Content-Type text/plain
200 text/plain
                        {"pass": "90c19ce2076db097c75b3406e966a6b6","ip": "192.168.254.2"}

                      
                        
                      

Check pass against user

REQUEST user pass verify

                          {"username":"anonymous","pass":"af77..."}

                        
                          
                        

RESPONSE

Headers
User login

Validation of user with validated password

Process log in to server

REQUEST verify user

Headers
Content-Type application/json
application/json
                          {"username":"anonymous","pass":"af77...","validated":"2793f..."}

                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "name of the user"
    },
    "pass": {
      "type": "string",
      "description": "pass for session validation"
    },
    "validated": {
      "type": "string",
      "description": "validated pass mixed with password"
    }
  }
}
                        

RESPONSE

response text here

Headers
Content-Type application/json
200 application/json
                        {"user-profile":""}

                      
                        
                      
User profile

User details

Update user profile

Updates the profile of the user

REQUEST user-update

Parameters
name string slevinski

The name of a user

Headers
Pass 5ffab638bde372b4fa63bb6f8484595d
                          null

                        
                          
                        

RESPONSE

Headers

Register new user

Creates and returns a new user

REQUEST user-add

Parameters
name string slevinski

The name of a user

Headers
Pass 5ffab638bde372b4fa63bb6f8484595d
                          null

                        
                          
                        

RESPONSE

Headers
Content-Type text/plain
200 text/plain
                        profile created and returned

                      
                        
                      
User password

User password resource

Update user password

Updates the password of the user

REQUEST user-update-password

Parameters
name string slevinski

The name of a user

Headers
Content-Type plain/text
Pass 5ffab638bde372b4fa63bb6f8484595d
plain/text
                          {"old":"149603e6c03516362a8da23f624db945","new":"22af645d1859cb5ca6da0c484f1f37ea"}

                        
                          
                        

RESPONSE

Headers

Reset user password

Creates a temporary password for the user

REQUEST user-password-reset

Parameters
name string slevinski

The name of a user

Headers
Content-Type plain/text
Pass 5ffab638bde372b4fa63bb6f8484595d
plain/text
                          null

                        
                          
                        

RESPONSE

Headers
User email requests

Requests for email of username or password reset

List of user email requests

User email requests for username or passwords

REQUEST user-email-request

Headers
Pass 5ffab638bde372b4fa63bb6f8484595d
                          null

                        
                          
                        

RESPONSE

Headers
Content-Type text/plain
200 text/plain
                        [{"name":"slevinski","email":"slevinski@signwriting.org","temp":"username"}]

                      
                        
                      
Username lookup

Forgot username email lookup

Lookup username

Creates a request for email of username

REQUEST user-name-lookup

Parameters
email string slevinski@signwriting.org

The email for a user

Headers
Pass 5ffab638bde372b4fa63bb6f8484595d
                          null

                        
                          
                        

RESPONSE

Headers