Ordyx Portal

Group of methods used for root to create, update, delete entities such as the admin’s Users, Settings(parameters), Email templates and other things such as CRM/Desk/Stripe grants, tokens, and keys.

GET the Admin’s recent activity in the portal

Revokes the Admin’s CRM token/key when session is expired or is User does not have the permissions

GET the Admin’s desk account information.

revokes the admins Desk token if user does not have permission or session expires.

Initializes the Admin’s system using parameters specified

View the admins Parameters:

• SMTP_USER
• ORDYX_TOKEN
• STRIPE_SECRET_KEY
• STRIPE_PUBLISH_KEY
• ZOHO_CRM_MANAGER_USER_ID
• ZOHO_CRM_PARTNERS
• ORDYX_BASE_URL
• ORDYX_LOGO_URL
• ORDYX_SECRET
• ZOHO_DESK_ORG_ID
• ZOHO_DESK_INSTALL_AGENT
• ZOHO_CRM_TOKEN_ACCESS
• SECRET_ORDYX
• SMTP_USER

Update the admins Parameters:

• SMTP_USER
• ORDYX_TOKEN
• STRIPE_SECRET_KEY
• STRIPE_PUBLISH_KEY
• ZOHO_CRM_MANAGER_USER_ID
• ZOHO_CRM_PARTNERS
• ORDYX_BASE_URL
• ORDYX_LOGO_URL
• ORDYX_SECRET
• ZOHO_DESK_ORG_ID
• ZOHO_DESK_INSTALL_AGENT
• ZOHO_CRM_TOKEN_ACCESS
• SECRET_ORDYX
• SMTP_USER

GETS the Admins Default Parameters which may be updated by the Admin.

• SMTP_USER
• ORDYX_TOKEN
• STRIPE_SECRET_KEY
• STRIPE_PUBLISH_KEY
• ZOHO_CRM_MANAGER_USER_ID
• ZOHO_CRM_PARTNERS
• ORDYX_BASE_URL
• ORDYX_LOGO_URL
• ORDYX_SECRET
• ZOHO_DESK_ORG_ID
• ZOHO_DESK_INSTALL_AGENT
• ZOHO_CRM_TOKEN_ACCESS
• SECRET_ORDYX
• SMTP_USER

GET the Admins Stripe Key used in credit card payment processing.

Delete one of the admins Parameters by specified Admin ParamID

• SMTP_USER
• ORDYX_TOKEN
• STRIPE_SECRET_KEY
• STRIPE_PUBLISH_KEY
• ZOHO_CRM_MANAGER_USER_ID
• ZOHO_CRM_PARTNERS
• ORDYX_BASE_URL
• ORDYX_LOGO_URL
• ORDYX_SECRET
• ZOHO_DESK_ORG_ID
• ZOHO_DESK_INSTALL_AGENT
• ZOHO_CRM_TOKEN_ACCESS
• SECRET_ORDYX
• SMTP_USER

GET Method invoked to view all the Admins current Email templates.

PUT method invoked to update an existing template or add a new email template.

GET method to view a specific email template by its unique template ID

DELETE method to remove a specific email template by its unique template ID

GET method to view all the users under a specified admin.

PUT method used in order to create a new User under an Admin as well as update an existing Users information.

Method used to delete a specific User by their user ID

Method used to view a specific User by their user ID

The authorization generated when acount is created

Method used to update authorization credentials when password is forgotten.

Updates the Users credentials to log them out. Token should not renew therefore it is not sent back.

Transfer a User already authenticated with Ordyx.

GET method used to make sure the Users credentials are validated with Ordyx.