Connect API API Reference

The Connect API handles authorization between users and the Geeny platform. This endpoint includes methods for registering and authenticating with the platform and retrieving lost passwords.

After registering, users are granted access to the platform API through a JSON Web Token. Users must supply this token with all requests to other endpoints.

API Endpoint
https://connect.geeny.io
Schemes: https
Version: 1.0.0

Authentication

basic

Paths

Refresh token

POST /auth/jwt/refresh/

Returns a refreshed JSON Web Token with a new expiration date based on an existing token.

If the orig_iat (original issued-at-time) field is found, Connect will first check to see if it is within the expiration window and then copy it to the new token.

token: string
Request Content-Types: application/json
Request Example
{
  "token": "string"
}
200 OK

A new token has been returned.

Response Example (200 OK)
{
  "token": "kf4j3XAiOiNVM3FiLCJhbGciOiJSUzUR4JN3.nfj4n2VyX2lkIjoiYjhkYjEyOTQtYTE0Ny00ZjFlLWIyZTEtODierjgnkMjdkNWI0IiwidXNllkjgeWUiOiJicmlhbkBleGFtcGxlLmNvbSIsImV4cCI6MTUwMDQ4MTYxOSwiZW1haWwiOiJicmlhbkBleGFtcGxlLmNvbSIsIm9yaWdfaWF0IjoxNTAwNDgxMzE5fQ..."
}

Verify token

POST /auth/jwt/verify/

Verifies whether the supplied token has expired. If it has not expired, then it is returned.

token: Token
Request Content-Types: application/json
Request Example
{
  "token": "kf4j3XAiOiNVM3FiLCJhbGciOiJSUzUR4JN3.nfj4n2VyX2lkIjoiYjhkYjEyOTQtYTE0Ny00ZjFlLWIyZTEtODierjgnkMjdkNWI0IiwidXNllkjgeWUiOiJicmlhbkBleGFtcGxlLmNvbSIsImV4cCI6MTUwMDQ4MTYxOSwiZW1haWwiOiJicmlhbkBleGFtcGxlLmNvbSIsIm9yaWdfaWF0IjoxNTAwNDgxMzE5fQ..."
}
200 OK

The token is still valid.

400 Bad Request

Token signature has expired.

Response Example (200 OK)
{
  "token": "kf4j3XAiOiNVM3FiLCJhbGciOiJSUzUR4JN3.nfj4n2VyX2lkIjoiYjhkYjEyOTQtYTE0Ny00ZjFlLWIyZTEtODierjgnkMjdkNWI0IiwidXNllkjgeWUiOiJicmlhbkBleGFtcGxlLmNvbSIsImV4cCI6MTUwMDQ4MTYxOSwiZW1haWwiOiJicmlhbkBleGFtcGxlLmNvbSIsIm9yaWdfaWF0IjoxNTAwNDgxMzE5fQ..."
}

Log in

POST /auth/login/

Logs the user in based on the credentials supplied in the request.

A JSON Web Token is returned upon successful login. This token must be supplied with all other API requests

email: string

The user's email address.

password: string

The user's password.

Request Content-Types: application/json
Request Example
{
  "email": "geenydocs@example.com",
  "password": "j$JfJ4hTNfk"
}
200 OK

Successful login.

Response Example (200 OK)
{
  "token": "kf4j3XAiOiNVM3FiLCJhbGciOiJSUzUR4JN3.nfj4n2VyX2lkIjoiYjhkYjEyOTQtYTE0Ny00ZjFlLWIyZTEtODierjgnkMjdkNWI0IiwidXNllkjgeWUiOiJicmlhbkBleGFtcGxlLmNvbSIsImV4cCI6MTUwMDQ4MTYxOSwiZW1haWwiOiJicmlhbkBleGFtcGxlLmNvbSIsIm9yaWdfaWF0IjoxNTAwNDgxMzE5fQ..."
}

Reset password

POST /auth/password/reset/

Sends a password reset email to the address supplied in the request.

email: string

Email address to receive the reset email.

Request Content-Types: application/json
Request Example
{
  "email": "string"
}
204 No Content

Reset email successfully sent.

Register new user

POST /auth/registration/

Registers a new user on the Geeny platform. Returns a JSON Web Token which must be used in all other API requests.

email: string

The new user's email address.

firstName: string

The new user's first name.

lastName: string

The new user's last name.

password: string

A password for the new user's account.

Request Content-Types: application/json
Request Example
{
  "email": "geenydocs@example.com",
  "firstName": "Geeny",
  "lastName": "Docs",
  "password": "JfJ4hTNfk"
}
201 Created

The new user is registered.

Response Example (201 Created)
{
  "token": "kf4j3XAiOiNVM3FiLCJhbGciOiJSUzUR4JN3.nfj4n2VyX2lkIjoiYjhkYjEyOTQtYTE0Ny00ZjFlLWIyZTEtODierjgnkMjdkNWI0IiwidXNllkjgeWUiOiJicmlhbkBleGFtcGxlLmNvbSIsImV4cCI6MTUwMDQ4MTYxOSwiZW1haWwiOiJicmlhbkBleGFtcGxlLmNvbSIsIm9yaWdfaWF0IjoxNTAwNDgxMzE5fQ..."
}

Verify new user

POST /auth/registration/verify-email/

Verifies the email address of a new user created with the "Register new user" request.

token: string

The user's authentication token.

uid: string

The user's system ID.

Request Content-Types: application/json
Request Example
{
  "token": "string",
  "uid": "string"
}
201 Created

User successfully verified.

400 Bad Request

Invalid token supplied.

Schema Definitions

tokenResponse: object

Response schema for calls that return a token.

token: Token

The user's JSON web token.

Example
{
  "token": "kf4j3XAiOiNVM3FiLCJhbGciOiJSUzUR4JN3.nfj4n2VyX2lkIjoiYjhkYjEyOTQtYTE0Ny00ZjFlLWIyZTEtODierjgnkMjdkNWI0IiwidXNllkjgeWUiOiJicmlhbkBleGFtcGxlLmNvbSIsImV4cCI6MTUwMDQ4MTYxOSwiZW1haWwiOiJicmlhbkBleGFtcGxlLmNvbSIsIm9yaWdfaWF0IjoxNTAwNDgxMzE5fQ..."
}

Token: string

A JSON Web Token that authenticates users with the API.